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

Update all json files; make some fixes to make it work at all

Browse Source
This commit is contained in:
Sebastian Thiel
2022-03-08 07:59:31 +08:00
parent d12cd3238e
commit 743a56f4b7
372 changed files with 256017 additions and 32197 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5621
apis.json Normal file
View File

File diff suppressed because it is too large Load Diff

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

@@ -139,7 +139,7 @@
}
}
},
"revision": "20210329",
"revision": "20220303",
"rootUrl": "https://abusiveexperiencereport.googleapis.com/",
"schemas": {
"SiteSummaryResponse": {

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

@@ -115,7 +115,7 @@
}
}
},
"revision": "20210330",
"revision": "20220305",
"rootUrl": "https://acceleratedmobilepageurl.googleapis.com/",
"schemas": {
"AmpUrl": {

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

@@ -3,7 +3,7 @@
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "View and manage your data across Google Cloud Platform services"
"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
}
}
}
@@ -14,7 +14,7 @@
"canonicalName": "Access Approval",
"description": "An API for controlling access to data by Google personnel.",
"discoveryVersion": "v1",
"documentationLink": "https://cloud.google.com/access-approval/docs",
"documentationLink": "https://cloud.google.com/cloud-provider-access-management/access-approval/docs",
"fullyEncodeReservedExpansion": true,
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
@@ -142,7 +142,7 @@
],
"parameters": {
"name": {
"description": "Name of the AccessApprovalSettings to retrieve.",
"description": "The name of the AccessApprovalSettings to retrieve. Format: \"{projects|folders|organizations}/{id}/accessApprovalSettings\"",
"location": "path",
"pattern": "^folders/[^/]+/accessApprovalSettings$",
"required": true,
@@ -261,7 +261,7 @@
],
"parameters": {
"name": {
"description": "Name of the approval request to retrieve.",
"description": "The name of the approval request to retrieve. Format: \"{projects|folders|organizations}/{id}/approvalRequests/{approval_request}\"",
"location": "path",
"pattern": "^folders/[^/]+/approvalRequests/[^/]+$",
"required": true,
@@ -358,7 +358,7 @@
],
"parameters": {
"name": {
"description": "Name of the AccessApprovalSettings to retrieve.",
"description": "The name of the AccessApprovalSettings to retrieve. Format: \"{projects|folders|organizations}/{id}/accessApprovalSettings\"",
"location": "path",
"pattern": "^organizations/[^/]+/accessApprovalSettings$",
"required": true,
@@ -477,7 +477,7 @@
],
"parameters": {
"name": {
"description": "Name of the approval request to retrieve.",
"description": "The name of the approval request to retrieve. Format: \"{projects|folders|organizations}/{id}/approvalRequests/{approval_request}\"",
"location": "path",
"pattern": "^organizations/[^/]+/approvalRequests/[^/]+$",
"required": true,
@@ -574,7 +574,7 @@
],
"parameters": {
"name": {
"description": "Name of the AccessApprovalSettings to retrieve.",
"description": "The name of the AccessApprovalSettings to retrieve. Format: \"{projects|folders|organizations}/{id}/accessApprovalSettings\"",
"location": "path",
"pattern": "^projects/[^/]+/accessApprovalSettings$",
"required": true,
@@ -693,7 +693,7 @@
],
"parameters": {
"name": {
"description": "Name of the approval request to retrieve.",
"description": "The name of the approval request to retrieve. Format: \"{projects|folders|organizations}/{id}/approvalRequests/{approval_request}\"",
"location": "path",
"pattern": "^projects/[^/]+/approvalRequests/[^/]+$",
"required": true,
@@ -754,7 +754,7 @@
}
}
},
"revision": "20210318",
"revision": "20220225",
"rootUrl": "https://accessapproval.googleapis.com/",
"schemas": {
"AccessApprovalSettings": {
@@ -762,7 +762,7 @@
"id": "AccessApprovalSettings",
"properties": {
"enrolledAncestor": {
"description": "Output only. This field is read only (not settable via UpdateAccessAccessApprovalSettings method). If the field is true, that indicates that at least one service is enrolled for Access Approval in one or more ancestors of the Project or Folder (this field will always be unset for the organization since organizations do not have ancestors).",
"description": "Output only. This field is read only (not settable via UpdateAccessApprovalSettings method). If the field is true, that indicates that at least one service is enrolled for Access Approval in one or more ancestors of the Project or Folder (this field will always be unset for the organization since organizations do not have ancestors).",
"readOnly": true,
"type": "boolean"
},
@@ -918,7 +918,7 @@
"type": "string"
},
"implicit": {
"description": "This field will be true if the ApprovalRequest was implcitly dismissed due to inaction by the access approval approvers (the request is not acted on by the approvers before the exiration time).",
"description": "This field will be true if the ApprovalRequest was implicitly dismissed due to inaction by the access approval approvers (the request is not acted on by the approvers before the exiration time).",
"type": "boolean"
}
},
@@ -935,7 +935,7 @@
"id": "EnrolledService",
"properties": {
"cloudProduct": {
"description": "The product for which Access Approval will be enrolled. Allowed values are listed below (case-sensitive): * all * App Engine * BigQuery * Cloud Bigtable * Cloud Key Management Service * Compute Engine * Cloud Dataflow * Cloud Identity and Access Management * Cloud Logging * Cloud Pub/Sub * Cloud Spanner * Cloud Storage * Persistent Disk Note: These values are supported as input for legacy purposes, but will not be returned from the API. * all * appengine.googleapis.com * bigquery.googleapis.com * bigtable.googleapis.com * cloudkms.googleapis.com * compute.googleapis.com * dataflow.googleapis.com * iam.googleapis.com * logging.googleapis.com * pubsub.googleapis.com * spanner.googleapis.com * storage.googleapis.com Calls to UpdateAccessApprovalSettings using 'all' or any of the XXX.googleapis.com will be translated to the associated product name ('all', 'App Engine', etc.). Note: 'all' will enroll the resource in all products supported at both 'GA' and 'Preview' levels. More information about levels of support is available at https://cloud.google.com/access-approval/docs/supported-services",
"description": "The product for which Access Approval will be enrolled. Allowed values are listed below (case-sensitive): * all * GA * App Engine * BigQuery * Cloud Bigtable * Cloud Key Management Service * Compute Engine * Cloud Dataflow * Cloud DLP * Cloud EKM * Cloud HSM * Cloud Identity and Access Management * Cloud Logging * Cloud Pub/Sub * Cloud Spanner * Cloud SQL * Cloud Storage * Google Kubernetes Engine * Organization Policy Serivice * Persistent Disk * Resource Manager * Speaker ID Note: These values are supported as input for legacy purposes, but will not be returned from the API. * all * ga-only * appengine.googleapis.com * bigquery.googleapis.com * bigtable.googleapis.com * container.googleapis.com * cloudkms.googleapis.com * cloudresourcemanager.googleapis.com * cloudsql.googleapis.com * compute.googleapis.com * dataflow.googleapis.com * dlp.googleapis.com * iam.googleapis.com * logging.googleapis.com * orgpolicy.googleapis.com * pubsub.googleapis.com * spanner.googleapis.com * speakerid.googleapis.com * storage.googleapis.com Calls to UpdateAccessApprovalSettings using 'all' or any of the XXX.googleapis.com will be translated to the associated product name ('all', 'App Engine', etc.). Note: 'all' will enroll the resource in all products supported at both 'GA' and 'Preview' levels. More information about levels of support is available at https://cloud.google.com/access-approval/docs/supported-services",
"type": "string"
},
"enrollmentLevel": {

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

@@ -3,7 +3,7 @@
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "See, edit, configure, and delete your Google Cloud Platform data"
"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
}
}
}
@@ -108,7 +108,7 @@
"accessPolicies": {
"methods": {
"create": {
"description": "Create an `AccessPolicy`. Fails if this organization already has a `AccessPolicy`. The longrunning Operation will have a successful status once the `AccessPolicy` has propagated to long-lasting storage. Syntactic and basic semantic errors will be returned in `metadata` as a BadRequest proto.",
"description": "Creates an access policy. This method fails if the organization already has an access policy. The long-running operation has a successful status after the access policy propagates to long-lasting storage. Syntactic and basic semantic errors are returned in `metadata` as a BadRequest proto.",
"flatPath": "v1/accessPolicies",
"httpMethod": "POST",
"id": "accesscontextmanager.accessPolicies.create",
@@ -126,7 +126,7 @@
]
},
"delete": {
"description": "Delete an AccessPolicy by resource name. The longrunning Operation will have a successful status once the AccessPolicy has been removed from long-lasting storage.",
"description": "Deletes an access policy based on the resource name. The long-running operation has a successful status after the access policy is removed from long-lasting storage.",
"flatPath": "v1/accessPolicies/{accessPoliciesId}",
"httpMethod": "DELETE",
"id": "accesscontextmanager.accessPolicies.delete",
@@ -151,7 +151,7 @@
]
},
"get": {
"description": "Get an AccessPolicy by name.",
"description": "Returns an access policy based on the name.",
"flatPath": "v1/accessPolicies/{accessPoliciesId}",
"httpMethod": "GET",
"id": "accesscontextmanager.accessPolicies.get",
@@ -175,8 +175,36 @@
"https://www.googleapis.com/auth/cloud-platform"
]
},
"getIamPolicy": {
"description": "Gets the IAM policy for the specified Access Context Manager access policy.",
"flatPath": "v1/accessPolicies/{accessPoliciesId}:getIamPolicy",
"httpMethod": "POST",
"id": "accesscontextmanager.accessPolicies.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": "^accessPolicies/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:getIamPolicy",
"request": {
"$ref": "GetIamPolicyRequest"
},
"response": {
"$ref": "Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "List all AccessPolicies under a container.",
"description": "Lists all access policies in an organization.",
"flatPath": "v1/accessPolicies",
"httpMethod": "GET",
"id": "accesscontextmanager.accessPolicies.list",
@@ -208,7 +236,7 @@
]
},
"patch": {
"description": "Update an AccessPolicy. The longrunning Operation from this RPC will have a successful status once the changes to the AccessPolicy have propagated to long-lasting storage. Syntactic and basic semantic errors will be returned in `metadata` as a BadRequest proto.",
"description": "Updates an access policy. The long-running operation from this RPC has a successful status after the changes to the access policy propagate to long-lasting storage.",
"flatPath": "v1/accessPolicies/{accessPoliciesId}",
"httpMethod": "PATCH",
"id": "accesscontextmanager.accessPolicies.patch",
@@ -217,7 +245,7 @@
],
"parameters": {
"name": {
"description": "Output only. Resource name of the `AccessPolicy`. Format: `accessPolicies/{policy_id}`",
"description": "Output only. Resource name of the `AccessPolicy`. Format: `accessPolicies/{access_policy}`",
"location": "path",
"pattern": "^accessPolicies/[^/]+$",
"required": true,
@@ -240,13 +268,69 @@
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"setIamPolicy": {
"description": "Sets the IAM policy for the specified Access Context Manager access policy. This method replaces the existing IAM policy on the access policy. The IAM policy controls the set of users who can perform specific operations on the Access Context Manager access policy.",
"flatPath": "v1/accessPolicies/{accessPoliciesId}:setIamPolicy",
"httpMethod": "POST",
"id": "accesscontextmanager.accessPolicies.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": "^accessPolicies/[^/]+$",
"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 the IAM permissions that the caller has on the specified Access Context Manager resource. The resource can be an AccessPolicy, AccessLevel, or ServicePerimeter. This method does not support other resources.",
"flatPath": "v1/accessPolicies/{accessPoliciesId}:testIamPermissions",
"httpMethod": "POST",
"id": "accesscontextmanager.accessPolicies.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": "^accessPolicies/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:testIamPermissions",
"request": {
"$ref": "TestIamPermissionsRequest"
},
"response": {
"$ref": "TestIamPermissionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
},
"resources": {
"accessLevels": {
"methods": {
"create": {
"description": "Create an Access Level. The longrunning operation from this RPC will have a successful status once the Access Level has propagated to long-lasting storage. Access Levels containing errors will result in an error response for the first error encountered.",
"description": "Creates an access level. The long-running operation from this RPC has a successful status after the access level propagates to long-lasting storage. If access levels contain errors, an error response is returned for the first error encountered.",
"flatPath": "v1/accessPolicies/{accessPoliciesId}/accessLevels",
"httpMethod": "POST",
"id": "accesscontextmanager.accessPolicies.accessLevels.create",
@@ -274,7 +358,7 @@
]
},
"delete": {
"description": "Delete an Access Level by resource name. The longrunning operation from this RPC will have a successful status once the Access Level has been removed from long-lasting storage.",
"description": "Deletes an access level based on the resource name. The long-running operation from this RPC has a successful status after the access level has been removed from long-lasting storage.",
"flatPath": "v1/accessPolicies/{accessPoliciesId}/accessLevels/{accessLevelsId}",
"httpMethod": "DELETE",
"id": "accesscontextmanager.accessPolicies.accessLevels.delete",
@@ -299,7 +383,7 @@
]
},
"get": {
"description": "Get an Access Level by resource name.",
"description": "Gets an access level based on the resource name.",
"flatPath": "v1/accessPolicies/{accessPoliciesId}/accessLevels/{accessLevelsId}",
"httpMethod": "GET",
"id": "accesscontextmanager.accessPolicies.accessLevels.get",
@@ -339,7 +423,7 @@
]
},
"list": {
"description": "List all Access Levels for an access policy.",
"description": "Lists all access levels for an access policy.",
"flatPath": "v1/accessPolicies/{accessPoliciesId}/accessLevels",
"httpMethod": "GET",
"id": "accesscontextmanager.accessPolicies.accessLevels.list",
@@ -390,7 +474,7 @@
]
},
"patch": {
"description": "Update an Access Level. The longrunning operation from this RPC will have a successful status once the changes to the Access Level have propagated to long-lasting storage. Access Levels containing errors will result in an error response for the first error encountered.",
"description": "Updates an access level. The long-running operation from this RPC has a successful status after the changes to the access level propagate to long-lasting storage. If access levels contain errors, an error response is returned for the first error encountered.",
"flatPath": "v1/accessPolicies/{accessPoliciesId}/accessLevels/{accessLevelsId}",
"httpMethod": "PATCH",
"id": "accesscontextmanager.accessPolicies.accessLevels.patch",
@@ -399,7 +483,7 @@
],
"parameters": {
"name": {
"description": "Required. Resource name for the Access Level. The `short_name` component must begin with a letter and only include alphanumeric and '_'. Format: `accessPolicies/{policy_id}/accessLevels/{short_name}`. The maximum length of the `short_name` component is 50 characters.",
"description": "Required. Resource name for the Access Level. The `short_name` component must begin with a letter and only include alphanumeric and '_'. Format: `accessPolicies/{access_policy}/accessLevels/{access_level}`. The maximum length of the `access_level` component is 50 characters.",
"location": "path",
"pattern": "^accessPolicies/[^/]+/accessLevels/[^/]+$",
"required": true,
@@ -424,7 +508,7 @@
]
},
"replaceAll": {
"description": "Replace all existing Access Levels in an Access Policy with the Access Levels provided. This is done atomically. The longrunning operation from this RPC will have a successful status once all replacements have propagated to long-lasting storage. Replacements containing errors will result in an error response for the first error encountered. Replacement will be cancelled on error, existing Access Levels will not be affected. Operation.response field will contain ReplaceAccessLevelsResponse. Removing Access Levels contained in existing Service Perimeters will result in error.",
"description": "Replaces all existing access levels in an access policy with the access levels provided. This is done atomically. The long-running operation from this RPC has a successful status after all replacements propagate to long-lasting storage. If the replacement contains errors, an error response is returned for the first error encountered. Upon error, the replacement is cancelled, and existing access levels are not affected. The Operation.response field contains ReplaceAccessLevelsResponse. Removing access levels contained in existing service perimeters result in an error.",
"flatPath": "v1/accessPolicies/{accessPoliciesId}/accessLevels:replaceAll",
"httpMethod": "POST",
"id": "accesscontextmanager.accessPolicies.accessLevels.replaceAll",
@@ -450,13 +534,41 @@
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"testIamPermissions": {
"description": "Returns the IAM permissions that the caller has on the specified Access Context Manager resource. The resource can be an AccessPolicy, AccessLevel, or ServicePerimeter. This method does not support other resources.",
"flatPath": "v1/accessPolicies/{accessPoliciesId}/accessLevels/{accessLevelsId}:testIamPermissions",
"httpMethod": "POST",
"id": "accesscontextmanager.accessPolicies.accessLevels.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": "^accessPolicies/[^/]+/accessLevels/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:testIamPermissions",
"request": {
"$ref": "TestIamPermissionsRequest"
},
"response": {
"$ref": "TestIamPermissionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"servicePerimeters": {
"methods": {
"commit": {
"description": "Commit the dry-run spec for all the Service Perimeters in an Access Policy. A commit operation on a Service Perimeter involves copying its `spec` field to that Service Perimeter's `status` field. Only Service Perimeters with `use_explicit_dry_run_spec` field set to true are affected by a commit operation. The longrunning operation from this RPC will have a successful status once the dry-run specs for all the Service Perimeters have been committed. If a commit fails, it will cause the longrunning operation to return an error response and the entire commit operation will be cancelled. When successful, Operation.response field will contain CommitServicePerimetersResponse. The `dry_run` and the `spec` fields will be cleared after a successful commit operation.",
"description": "Commits the dry-run specification for all the service perimeters in an access policy. A commit operation on a service perimeter involves copying its `spec` field to the `status` field of the service perimeter. Only service perimeters with `use_explicit_dry_run_spec` field set to true are affected by a commit operation. The long-running operation from this RPC has a successful status after the dry-run specifications for all the service perimeters have been committed. If a commit fails, it causes the long-running operation to return an error response and the entire commit operation is cancelled. When successful, the Operation.response field contains CommitServicePerimetersResponse. The `dry_run` and the `spec` fields are cleared after a successful commit operation.",
"flatPath": "v1/accessPolicies/{accessPoliciesId}/servicePerimeters:commit",
"httpMethod": "POST",
"id": "accesscontextmanager.accessPolicies.servicePerimeters.commit",
@@ -484,7 +596,7 @@
]
},
"create": {
"description": "Create a Service Perimeter. The longrunning operation from this RPC will have a successful status once the Service Perimeter has propagated to long-lasting storage. Service Perimeters containing errors will result in an error response for the first error encountered.",
"description": "Creates a service perimeter. The long-running operation from this RPC has a successful status after the service perimeter propagates to long-lasting storage. If a service perimeter contains errors, an error response is returned for the first error encountered.",
"flatPath": "v1/accessPolicies/{accessPoliciesId}/servicePerimeters",
"httpMethod": "POST",
"id": "accesscontextmanager.accessPolicies.servicePerimeters.create",
@@ -512,7 +624,7 @@
]
},
"delete": {
"description": "Delete a Service Perimeter by resource name. The longrunning operation from this RPC will have a successful status once the Service Perimeter has been removed from long-lasting storage.",
"description": "Deletes a service perimeter based on the resource name. The long-running operation from this RPC has a successful status after the service perimeter is removed from long-lasting storage.",
"flatPath": "v1/accessPolicies/{accessPoliciesId}/servicePerimeters/{servicePerimetersId}",
"httpMethod": "DELETE",
"id": "accesscontextmanager.accessPolicies.servicePerimeters.delete",
@@ -537,7 +649,7 @@
]
},
"get": {
"description": "Get a Service Perimeter by resource name.",
"description": "Gets a service perimeter based on the resource name.",
"flatPath": "v1/accessPolicies/{accessPoliciesId}/servicePerimeters/{servicePerimetersId}",
"httpMethod": "GET",
"id": "accesscontextmanager.accessPolicies.servicePerimeters.get",
@@ -562,7 +674,7 @@
]
},
"list": {
"description": "List all Service Perimeters for an access policy.",
"description": "Lists all service perimeters for an access policy.",
"flatPath": "v1/accessPolicies/{accessPoliciesId}/servicePerimeters",
"httpMethod": "GET",
"id": "accesscontextmanager.accessPolicies.servicePerimeters.list",
@@ -598,7 +710,7 @@
]
},
"patch": {
"description": "Update a Service Perimeter. The longrunning operation from this RPC will have a successful status once the changes to the Service Perimeter have propagated to long-lasting storage. Service Perimeter containing errors will result in an error response for the first error encountered.",
"description": "Updates a service perimeter. The long-running operation from this RPC has a successful status after the service perimeter propagates to long-lasting storage. If a service perimeter contains errors, an error response is returned for the first error encountered.",
"flatPath": "v1/accessPolicies/{accessPoliciesId}/servicePerimeters/{servicePerimetersId}",
"httpMethod": "PATCH",
"id": "accesscontextmanager.accessPolicies.servicePerimeters.patch",
@@ -607,7 +719,7 @@
],
"parameters": {
"name": {
"description": "Required. Resource name for the ServicePerimeter. The `short_name` component must begin with a letter and only include alphanumeric and '_'. Format: `accessPolicies/{policy_id}/servicePerimeters/{short_name}`",
"description": "Required. Resource name for the ServicePerimeter. The `short_name` component must begin with a letter and only include alphanumeric and '_'. Format: `accessPolicies/{access_policy}/servicePerimeters/{service_perimeter}`",
"location": "path",
"pattern": "^accessPolicies/[^/]+/servicePerimeters/[^/]+$",
"required": true,
@@ -632,7 +744,7 @@
]
},
"replaceAll": {
"description": "Replace all existing Service Perimeters in an Access Policy with the Service Perimeters provided. This is done atomically. The longrunning operation from this RPC will have a successful status once all replacements have propagated to long-lasting storage. Replacements containing errors will result in an error response for the first error encountered. Replacement will be cancelled on error, existing Service Perimeters will not be affected. Operation.response field will contain ReplaceServicePerimetersResponse.",
"description": "Replace all existing service perimeters in an access policy with the service perimeters provided. This is done atomically. The long-running operation from this RPC has a successful status after all replacements propagate to long-lasting storage. Replacements containing errors result in an error response for the first error encountered. Upon an error, replacement are cancelled and existing service perimeters are not affected. The Operation.response field contains ReplaceServicePerimetersResponse.",
"flatPath": "v1/accessPolicies/{accessPoliciesId}/servicePerimeters:replaceAll",
"httpMethod": "POST",
"id": "accesscontextmanager.accessPolicies.servicePerimeters.replaceAll",
@@ -658,6 +770,34 @@
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"testIamPermissions": {
"description": "Returns the IAM permissions that the caller has on the specified Access Context Manager resource. The resource can be an AccessPolicy, AccessLevel, or ServicePerimeter. This method does not support other resources.",
"flatPath": "v1/accessPolicies/{accessPoliciesId}/servicePerimeters/{servicePerimetersId}:testIamPermissions",
"httpMethod": "POST",
"id": "accesscontextmanager.accessPolicies.servicePerimeters.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": "^accessPolicies/[^/]+/servicePerimeters/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:testIamPermissions",
"request": {
"$ref": "TestIamPermissionsRequest"
},
"response": {
"$ref": "TestIamPermissionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
@@ -791,7 +931,7 @@
"gcpUserAccessBindings": {
"methods": {
"create": {
"description": "Creates a GcpUserAccessBinding. If the client specifies a name, the server will ignore it. Fails if a resource already exists with the same group_key. Completion of this long-running operation does not necessarily signify that the new binding is deployed onto all affected users, which may take more time.",
"description": "Creates a GcpUserAccessBinding. If the client specifies a name, the server ignores it. Fails if a resource already exists with the same group_key. Completion of this long-running operation does not necessarily signify that the new binding is deployed onto all affected users, which may take more time.",
"flatPath": "v1/organizations/{organizationsId}/gcpUserAccessBindings",
"httpMethod": "POST",
"id": "accesscontextmanager.organizations.gcpUserAccessBindings.create",
@@ -943,9 +1083,15 @@
}
}
},
"revision": "20210319",
"revision": "20220301",
"rootUrl": "https://accesscontextmanager.googleapis.com/",
"schemas": {
"AccessContextManagerOperationMetadata": {
"description": "Metadata of Access Context Manager's Long Running Operations.",
"id": "AccessContextManagerOperationMetadata",
"properties": {},
"type": "object"
},
"AccessLevel": {
"description": "An `AccessLevel` is a label that can be applied to requests to Google Cloud services, along with a list of requirements necessary for the label to be applied.",
"id": "AccessLevel",
@@ -963,7 +1109,7 @@
"type": "string"
},
"name": {
"description": "Required. Resource name for the Access Level. The `short_name` component must begin with a letter and only include alphanumeric and '_'. Format: `accessPolicies/{policy_id}/accessLevels/{short_name}`. The maximum length of the `short_name` component is 50 characters.",
"description": "Required. Resource name for the Access Level. The `short_name` component must begin with a letter and only include alphanumeric and '_'. Format: `accessPolicies/{access_policy}/accessLevels/{access_level}`. The maximum length of the `access_level` component is 50 characters.",
"type": "string"
},
"title": {
@@ -982,13 +1128,20 @@
"type": "string"
},
"name": {
"description": "Output only. Resource name of the `AccessPolicy`. Format: `accessPolicies/{policy_id}`",
"description": "Output only. Resource name of the `AccessPolicy`. Format: `accessPolicies/{access_policy}`",
"type": "string"
},
"parent": {
"description": "Required. The parent of this `AccessPolicy` in the Cloud Resource Hierarchy. Currently immutable once created. Format: `organizations/{organization_id}`",
"type": "string"
},
"scopes": {
"description": "The scopes of a policy define which resources an ACM policy can restrict, and where ACM resources can be referenced. For example, a policy with scopes=[\"folders/123\"] has the following behavior: - vpcsc perimeters can only restrict projects within folders/123 - access levels can only be referenced by resources within folders/123. If empty, there are no limitations on which resources can be restricted by an ACM policy, and there are no limitations on where ACM resources can be referenced. Only one policy can include a given scope (attempting to create a second policy which includes \"folders/123\" will result in an error). Currently, scopes cannot be modified after a policy is created. Currently, policies can only have a single scope. Format: list of `folders/{folder_number}` or `projects/{project_number}`",
"items": {
"type": "string"
},
"type": "array"
},
"title": {
"description": "Required. Human readable title. Does not affect behavior.",
"type": "string"
@@ -1014,6 +1167,54 @@
},
"type": "object"
},
"AuditConfig": {
"description": "Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { \"audit_configs\": [ { \"service\": \"allServices\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" }, { \"log_type\": \"ADMIN_READ\" } ] }, { \"service\": \"sampleservice.googleapis.com\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\" }, { \"log_type\": \"DATA_WRITE\", \"exempted_members\": [ \"user:aliya@example.com\" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.",
"id": "AuditConfig",
"properties": {
"auditLogConfigs": {
"description": "The configuration for logging of each type of permission.",
"items": {
"$ref": "AuditLogConfig"
},
"type": "array"
},
"service": {
"description": "Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.",
"type": "string"
}
},
"type": "object"
},
"AuditLogConfig": {
"description": "Provides the configuration for logging a type of permissions. Example: { \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.",
"id": "AuditLogConfig",
"properties": {
"exemptedMembers": {
"description": "Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.",
"items": {
"type": "string"
},
"type": "array"
},
"logType": {
"description": "The log type that this config enables.",
"enum": [
"LOG_TYPE_UNSPECIFIED",
"ADMIN_READ",
"DATA_WRITE",
"DATA_READ"
],
"enumDescriptions": [
"Default case. Should never be this.",
"Admin reads. Example: CloudIAM getIamPolicy",
"Data writes. Example: CloudSQL Users create",
"Data reads. Example: CloudSQL Users list"
],
"type": "string"
}
},
"type": "object"
},
"BasicLevel": {
"description": "`BasicLevel` is an `AccessLevel` using a set of recommended features.",
"id": "BasicLevel",
@@ -1040,6 +1241,28 @@
},
"type": "object"
},
"Binding": {
"description": "Associates `members`, or principals, with a `role`.",
"id": "Binding",
"properties": {
"condition": {
"$ref": "Expr",
"description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)."
},
"members": {
"description": "Specifies the principals requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ",
"items": {
"type": "string"
},
"type": "array"
},
"role": {
"description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.",
"type": "string"
}
},
"type": "object"
},
"CancelOperationRequest": {
"description": "The request message for Operations.CancelOperation.",
"id": "CancelOperationRequest",
@@ -1190,7 +1413,7 @@
"type": "object"
},
"EgressFrom": {
"description": "Defines the conditions under which an EgressPolicy matches a request. Conditions based on information about the source of the request. Note that if the destination of the request is protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed.",
"description": "Defines the conditions under which an EgressPolicy matches a request. Conditions based on information about the source of the request. Note that if the destination of the request is also protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed.",
"id": "EgressFrom",
"properties": {
"identities": {
@@ -1235,18 +1458,18 @@
"type": "object"
},
"EgressTo": {
"description": "Defines the conditions under which an EgressPolicy matches a request. Conditions are based on information about the ApiOperation intended to be performed on the `resources` specified. Note that if the destination of the request is protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed.",
"description": "Defines the conditions under which an EgressPolicy matches a request. Conditions are based on information about the ApiOperation intended to be performed on the `resources` specified. Note that if the destination of the request is also protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed. The request must match `operations` AND `resources` fields in order to be allowed egress out of the perimeter.",
"id": "EgressTo",
"properties": {
"operations": {
"description": "A list of ApiOperations that this egress rule applies to. A request matches if it contains an operation/service in this list.",
"description": "A list of ApiOperations allowed to be performed by the sources specified in the corresponding EgressFrom. A request matches if it uses an operation/service in this list.",
"items": {
"$ref": "ApiOperation"
},
"type": "array"
},
"resources": {
"description": "A list of resources, currently only projects in the form `projects/`, that match this to stanza. A request matches if it contains a resource in this list. If `*` is specified for resources, then this EgressTo rule will authorize access to all resources outside the perimeter.",
"description": "A list of resources, currently only projects in the form `projects/`, that are allowed to be accessed by sources defined in the corresponding EgressFrom. A request matches if it contains a resource in this list. If `*` is specified for `resources`, then this EgressTo rule will authorize access to all resources outside the perimeter.",
"items": {
"type": "string"
},
@@ -1306,8 +1529,37 @@
},
"type": "object"
},
"GcpUserAccessBindingOperationMetadata": {
"description": "Currently, a completed operation means nothing. In the future, this metadata and a completed operation may indicate that the binding has taken effect and is affecting access decisions for all users.",
"id": "GcpUserAccessBindingOperationMetadata",
"properties": {},
"type": "object"
},
"GetIamPolicyRequest": {
"description": "Request message for `GetIamPolicy` method.",
"id": "GetIamPolicyRequest",
"properties": {
"options": {
"$ref": "GetPolicyOptions",
"description": "OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`."
}
},
"type": "object"
},
"GetPolicyOptions": {
"description": "Encapsulates settings provided to GetIamPolicy.",
"id": "GetPolicyOptions",
"properties": {
"requestedPolicyVersion": {
"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"IngressFrom": {
"description": "Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the source of the request.",
"description": "Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the source of the request. The request must satisfy what is defined in `sources` AND identity related fields in order to match.",
"id": "IngressFrom",
"properties": {
"identities": {
@@ -1363,7 +1615,7 @@
"id": "IngressSource",
"properties": {
"accessLevel": {
"description": "An AccessLevel resource name that allow resources within the ServicePerimeters to be accessed from the internet. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If no AccessLevel names are listed, resources within the perimeter can only be accessed via Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If `*` is specified, then all IngressSources will be allowed.",
"description": "An AccessLevel resource name that allow resources within the ServicePerimeters to be accessed from the internet. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If no AccessLevel names are listed, resources within the perimeter can only be accessed via Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all IngressSources will be allowed.",
"type": "string"
},
"resource": {
@@ -1374,18 +1626,18 @@
"type": "object"
},
"IngressTo": {
"description": "Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the ApiOperation intended to be performed on the destination of the request.",
"description": "Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the ApiOperation intended to be performed on the target resource of the request. The request must satisfy what is defined in `operations` AND `resources` in order to match.",
"id": "IngressTo",
"properties": {
"operations": {
"description": "A list of ApiOperations the sources specified in corresponding IngressFrom are allowed to perform in this ServicePerimeter.",
"description": "A list of ApiOperations allowed to be performed by the sources specified in corresponding IngressFrom in this ServicePerimeter.",
"items": {
"$ref": "ApiOperation"
},
"type": "array"
},
"resources": {
"description": "A list of resources, currently only projects in the form `projects/`, protected by this ServicePerimeter that are allowed to be accessed by sources defined in the corresponding IngressFrom. A request matches if it contains a resource in this list. If `*` is specified for resources, then this IngressTo rule will authorize access to all resources inside the perimeter, provided that the request also matches the `operations` field.",
"description": "A list of resources, currently only projects in the form `projects/`, protected by this ServicePerimeter that are allowed to be accessed by sources defined in the corresponding IngressFrom. If a single `*` is specified, then access to all resources inside the perimeter are allowed.",
"items": {
"type": "string"
},
@@ -1571,6 +1823,37 @@
},
"type": "object"
},
"Policy": {
"description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).",
"id": "Policy",
"properties": {
"auditConfigs": {
"description": "Specifies cloud audit logging configuration for this policy.",
"items": {
"$ref": "AuditConfig"
},
"type": "array"
},
"bindings": {
"description": "Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.",
"items": {
"$ref": "Binding"
},
"type": "array"
},
"etag": {
"description": "`etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.",
"format": "byte",
"type": "string"
},
"version": {
"description": "Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"ReplaceAccessLevelsRequest": {
"description": "A request to replace all existing Access Levels in an Access Policy with the Access Levels provided. This is done atomically.",
"id": "ReplaceAccessLevelsRequest",
@@ -1644,7 +1927,7 @@
"type": "string"
},
"name": {
"description": "Required. Resource name for the ServicePerimeter. The `short_name` component must begin with a letter and only include alphanumeric and '_'. Format: `accessPolicies/{policy_id}/servicePerimeters/{short_name}`",
"description": "Required. Resource name for the ServicePerimeter. The `short_name` component must begin with a letter and only include alphanumeric and '_'. Format: `accessPolicies/{access_policy}/servicePerimeters/{service_perimeter}`",
"type": "string"
},
"perimeterType": {
@@ -1724,6 +2007,22 @@
},
"type": "object"
},
"SetIamPolicyRequest": {
"description": "Request message for `SetIamPolicy` method.",
"id": "SetIamPolicyRequest",
"properties": {
"policy": {
"$ref": "Policy",
"description": "REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them."
},
"updateMask": {
"description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: \"bindings, etag\"`",
"format": "google-fieldmask",
"type": "string"
}
},
"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). 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",
@@ -1751,6 +2050,34 @@
},
"type": "object"
},
"TestIamPermissionsRequest": {
"description": "Request message for `TestIamPermissions` method.",
"id": "TestIamPermissionsRequest",
"properties": {
"permissions": {
"description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"TestIamPermissionsResponse": {
"description": "Response message for `TestIamPermissions` method.",
"id": "TestIamPermissionsResponse",
"properties": {
"permissions": {
"description": "A subset of `TestPermissionsRequest.permissions` that the caller is allowed.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"VpcAccessibleServices": {
"description": "Specifies how APIs are allowed to communicate within the Service Perimeter.",
"id": "VpcAccessibleServices",

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

@@ -3,7 +3,7 @@
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "See, edit, configure, and delete your Google Cloud Platform data"
"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
}
}
}
@@ -609,9 +609,15 @@
}
}
},
"revision": "20210319",
"revision": "20220301",
"rootUrl": "https://accesscontextmanager.googleapis.com/",
"schemas": {
"AccessContextManagerOperationMetadata": {
"description": "Metadata of Access Context Manager's Long Running Operations.",
"id": "AccessContextManagerOperationMetadata",
"properties": {},
"type": "object"
},
"AccessLevel": {
"description": "An `AccessLevel` is a label that can be applied to requests to Google Cloud services, along with a list of requirements necessary for the label to be applied.",
"id": "AccessLevel",

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

@@ -900,6 +900,74 @@
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
]
},
"pause": {
"description": "Update given deals to pause serving. This method will set the `DealServingMetadata.DealPauseStatus.has_buyer_paused` bit to true for all listed deals in the request. Currently, this method only applies to PG and PD deals. For PA deals, please call accounts.proposals.pause endpoint. It is a no-op to pause already-paused deals. It is an error to call PauseProposalDeals for deals which are not part of the proposal of proposal_id or which are not finalized or renegotiating.",
"flatPath": "v2beta1/accounts/{accountId}/finalizedProposals/{proposalId}:pause",
"httpMethod": "POST",
"id": "adexchangebuyer2.accounts.finalizedProposals.pause",
"parameterOrder": [
"accountId",
"proposalId"
],
"parameters": {
"accountId": {
"description": "Account ID of the buyer.",
"location": "path",
"required": true,
"type": "string"
},
"proposalId": {
"description": "The proposal_id of the proposal containing the deals.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "v2beta1/accounts/{accountId}/finalizedProposals/{proposalId}:pause",
"request": {
"$ref": "PauseProposalDealsRequest"
},
"response": {
"$ref": "Proposal"
},
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
]
},
"resume": {
"description": "Update given deals to resume serving. This method will set the `DealServingMetadata.DealPauseStatus.has_buyer_paused` bit to false for all listed deals in the request. Currently, this method only applies to PG and PD deals. For PA deals, please call accounts.proposals.resume endpoint. It is a no-op to resume running deals or deals paused by the other party. It is an error to call ResumeProposalDeals for deals which are not part of the proposal of proposal_id or which are not finalized or renegotiating.",
"flatPath": "v2beta1/accounts/{accountId}/finalizedProposals/{proposalId}:resume",
"httpMethod": "POST",
"id": "adexchangebuyer2.accounts.finalizedProposals.resume",
"parameterOrder": [
"accountId",
"proposalId"
],
"parameters": {
"accountId": {
"description": "Account ID of the buyer.",
"location": "path",
"required": true,
"type": "string"
},
"proposalId": {
"description": "The proposal_id of the proposal containing the deals.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "v2beta1/accounts/{accountId}/finalizedProposals/{proposalId}:resume",
"request": {
"$ref": "ResumeProposalDealsRequest"
},
"response": {
"$ref": "Proposal"
},
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
]
}
}
},
@@ -2500,7 +2568,7 @@
}
}
},
"revision": "20210331",
"revision": "20220307",
"rootUrl": "https://adexchangebuyer.googleapis.com/",
"schemas": {
"AbsoluteDateRange": {
@@ -2767,7 +2835,7 @@
"type": "string"
},
"clientName": {
"description": "Name used to represent this client to publishers. You may have multiple clients that map to the same entity, but for each client the combination of `clientName` and entity must be unique. You can specify this field as empty.",
"description": "Name used to represent this client to publishers. You may have multiple clients that map to the same entity, but for each client the combination of `clientName` and entity must be unique. You can specify this field as empty. Maximum length of 255 characters is allowed.",
"type": "string"
},
"entityId": {
@@ -3460,7 +3528,7 @@
"type": "object"
},
"Date": {
"description": "Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.",
"description": "Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp",
"id": "Date",
"properties": {
"day": {
@@ -4082,7 +4150,7 @@
"Financial service ad does not adhere to specifications.",
"Flash content was found in an unsupported context.",
"Misuse by an Open Measurement SDK script.",
"Use of an Open Measurement SDK vendor not on approved whitelist.",
"Use of an Open Measurement SDK vendor not on approved vendor list.",
"Unacceptable landing page.",
"Unsupported language.",
"Non-SSL compliant.",
@@ -4336,7 +4404,9 @@
"DAY",
"WEEK",
"MONTH",
"LIFETIME"
"LIFETIME",
"POD",
"STREAM"
],
"enumDescriptions": [
"A placeholder for an undefined time unit type. This just indicates the variable with this value hasn't been initialized.",
@@ -4345,7 +4415,9 @@
"Day",
"Week",
"Month",
"Lifetime"
"Lifetime",
"Pod",
"Stream"
],
"type": "string"
}
@@ -4373,10 +4445,34 @@
"format": "int64",
"type": "string"
},
"impressionCap": {
"description": "The lifetime impression cap for CPM sponsorship deals. The deal will stop serving when the cap is reached.",
"format": "int64",
"type": "string"
},
"minimumDailyLooks": {
"description": "Daily minimum looks for CPD deal types.",
"format": "int64",
"type": "string"
},
"percentShareOfVoice": {
"description": "For sponsorship deals, this is the percentage of the seller's eligible impressions that the deal will serve until the cap is reached.",
"format": "int64",
"type": "string"
},
"reservationType": {
"description": "The reservation type for a Programmatic Guaranteed deal. This indicates whether the number of impressions is fixed, or a percent of available impressions. If not specified, the default reservation type is STANDARD.",
"enum": [
"RESERVATION_TYPE_UNSPECIFIED",
"STANDARD",
"SPONSORSHIP"
],
"enumDescriptions": [
"An unspecified reservation type.",
"Non-sponsorship deal.",
"Sponsorship deals don't have impression goal (guaranteed_looks) and they are served based on the flight dates. For CPM Sponsorship deals, impression_cap is the lifetime impression limit."
],
"type": "string"
}
},
"type": "object"
@@ -5045,7 +5141,7 @@
"type": "object"
},
"NonGuaranteedFixedPriceTerms": {
"description": "Terms for Preferred Deals. Note that Preferred Deals cannot be created via the API at this time, but can be returned in a get or list request.",
"description": "Terms for Preferred Deals.",
"id": "NonGuaranteedFixedPriceTerms",
"properties": {
"fixedPrices": {
@@ -5116,6 +5212,24 @@
},
"type": "object"
},
"PauseProposalDealsRequest": {
"description": "Request message to pause serving for finalized deals.",
"id": "PauseProposalDealsRequest",
"properties": {
"externalDealIds": {
"description": "The external_deal_id's of the deals to be paused. If empty, all the deals in the proposal will be paused.",
"items": {
"type": "string"
},
"type": "array"
},
"reason": {
"description": "The reason why the deals are being paused. This human readable message will be displayed in the seller's UI. (Max length: 1000 unicode code units.)",
"type": "string"
}
},
"type": "object"
},
"PauseProposalRequest": {
"description": "Request message to pause serving for an already-finalized proposal.",
"id": "PauseProposalRequest",
@@ -5225,7 +5339,7 @@
"type": "object"
},
"Product": {
"description": "Note: this resource requires whitelisting for access. Please contact your account manager for access to Marketplace resources. A product is a segment of inventory that a seller wishes to sell. It is associated with certain terms and targeting information which helps the buyer know more about the inventory.",
"description": "A product is a segment of inventory that a seller wishes to sell. It is associated with certain terms and targeting information which helps the buyer know more about the inventory.",
"id": "Product",
"properties": {
"availableEndTime": {
@@ -5317,7 +5431,7 @@
"type": "object"
},
"Proposal": {
"description": "Note: this resource requires whitelisting for access. Please contact your account manager for access to Marketplace resources. Represents a proposal in the Marketplace. A proposal is the unit of negotiation between a seller and a buyer and contains deals which are served. Note: you can not update, create, or otherwise modify Private Auction or Preferred Deals deals through the API. Fields are updatable unless noted otherwise.",
"description": "Represents a proposal in the Marketplace. A proposal is the unit of negotiation between a seller and a buyer and contains deals which are served. Note: You can't update, create, or otherwise modify Private Auction deals through the API. Fields are updatable unless noted otherwise.",
"id": "Proposal",
"properties": {
"billedBuyer": {
@@ -5463,7 +5577,7 @@
"type": "object"
},
"PublisherProfile": {
"description": "Note: this resource requires whitelisting for access. Please contact your account manager for access to Marketplace resources. Represents a publisher profile (https://support.google.com/admanager/answer/6035806) in Marketplace. All fields are read only. All string fields are free-form text entered by the publisher unless noted otherwise.",
"description": "Represents a publisher profile (https://support.google.com/admanager/answer/6035806) in Marketplace. All fields are read only. All string fields are free-form text entered by the publisher unless noted otherwise.",
"id": "PublisherProfile",
"properties": {
"audienceDescription": {
@@ -5635,6 +5749,20 @@
},
"type": "object"
},
"ResumeProposalDealsRequest": {
"description": "Request message to resume (unpause) serving for already-finalized deals.",
"id": "ResumeProposalDealsRequest",
"properties": {
"externalDealIds": {
"description": "The external_deal_id's of the deals to resume. If empty, all the deals in the proposal will be resumed.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ResumeProposalRequest": {
"description": "Request message to resume (unpause) serving for an already-finalized proposal.",
"id": "ResumeProposalRequest",
@@ -5687,7 +5815,8 @@
"type": "string"
},
"subAccountId": {
"description": "Optional sub-account ID for the seller.",
"description": "Output only. Ad manager network code for the seller.",
"readOnly": true,
"type": "string"
}
},

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

@@ -138,7 +138,7 @@
}
}
},
"revision": "20210329",
"revision": "20220303",
"rootUrl": "https://adexperiencereport.googleapis.com/",
"schemas": {
"PlatformSummary": {

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

@@ -17,7 +17,7 @@
"canonicalName": "DataTransfer",
"description": "Admin SDK lets administrators of enterprise domains to view and manage resources like user, groups etc. It also provides audit and usage reports of domain.",
"discoveryVersion": "v1",
"documentationLink": "http://developers.google.com/admin-sdk/",
"documentationLink": "https://developers.google.com/admin-sdk/",
"fullyEncodeReservedExpansion": true,
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
@@ -272,7 +272,7 @@
}
}
},
"revision": "20210330",
"revision": "20220301",
"rootUrl": "https://admin.googleapis.com/",
"schemas": {
"Application": {

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

@@ -87,7 +87,7 @@
"description": "View user schemas on your domain"
},
"https://www.googleapis.com/auth/cloud-platform": {
"description": "See, edit, configure, and delete your Google Cloud Platform data"
"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
}
}
}
@@ -98,7 +98,7 @@
"canonicalName": "directory",
"description": "Admin SDK lets administrators of enterprise domains to view and manage resources like user, groups etc. It also provides audit and usage reports of domain.",
"discoveryVersion": "v1",
"documentationLink": "http://developers.google.com/admin-sdk/",
"documentationLink": "https://developers.google.com/admin-sdk/",
"fullyEncodeReservedExpansion": true,
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
@@ -193,7 +193,7 @@
"asps": {
"methods": {
"delete": {
"description": "Delete an ASP issued by a user.",
"description": "Deletes an ASP issued by a user.",
"flatPath": "admin/directory/v1/users/{userKey}/asps/{codeId}",
"httpMethod": "DELETE",
"id": "directory.asps.delete",
@@ -222,7 +222,7 @@
]
},
"get": {
"description": "Get information about an ASP issued by a user.",
"description": "Gets information about an ASP issued by a user.",
"flatPath": "admin/directory/v1/users/{userKey}/asps/{codeId}",
"httpMethod": "GET",
"id": "directory.asps.get",
@@ -254,7 +254,7 @@
]
},
"list": {
"description": "List the ASPs issued by a user.",
"description": "Lists the ASPs issued by a user.",
"flatPath": "admin/directory/v1/users/{userKey}/asps",
"httpMethod": "GET",
"id": "directory.asps.list",
@@ -282,7 +282,7 @@
"channels": {
"methods": {
"stop": {
"description": "Stop watching resources through this channel.",
"description": "Stops watching resources through this channel.",
"flatPath": "admin/directory_v1/channels/stop",
"httpMethod": "POST",
"id": "admin.channels.stop",
@@ -395,6 +395,11 @@
"required": true,
"type": "string"
},
"includeChildOrgunits": {
"description": "Return devices from all child orgunits, as well as the specified org unit. If this is set to true 'orgUnitPath' must be provided.",
"location": "query",
"type": "boolean"
},
"maxResults": {
"default": "100",
"description": "Maximum number of results to return.",
@@ -427,7 +432,7 @@
"type": "string"
},
"orgUnitPath": {
"description": "The full path of the organizational unit or its unique ID.",
"description": "The full path of the organizational unit (minus the leading `/`) or its unique ID.",
"location": "query",
"type": "string"
},
@@ -450,7 +455,7 @@
"type": "string"
},
"query": {
"description": "Search string in the format given at http://support.google.com/chromeos/a/bin/answer.py?answer=1698333",
"description": "Search string in the format given at https://developers.google.com/admin-sdk/directory/v1/list-query-operators",
"location": "query",
"type": "string"
},
@@ -478,7 +483,7 @@
]
},
"moveDevicesToOu": {
"description": "Move or insert multiple Chrome OS devices to an organizational unit. You can move up to 50 devices at once.",
"description": "Moves or inserts multiple Chrome OS devices to an organizational unit. You can move up to 50 devices at once.",
"flatPath": "admin/directory/v1/customer/{customerId}/devices/chromeos/moveDevicesToOu",
"httpMethod": "POST",
"id": "directory.chromeosdevices.moveDevicesToOu",
@@ -724,7 +729,7 @@
]
},
"patch": {
"description": "Patch Customers via Apiary Patch Orchestration",
"description": "Patches a customer.",
"flatPath": "admin/directory/v1/customers/{customerKey}",
"httpMethod": "PATCH",
"id": "directory.customers.patch",
@@ -932,6 +937,11 @@
"location": "query",
"type": "string"
},
"orderBy": {
"description": "The order to sort results by. Must be one of display_name, description, make_and_model, or create_time. Default order is ascending, but descending order can be returned by appending \"desc\" to the order_by field. For instance, \"description desc\" will return the printers sorted by description in descending order.",
"location": "query",
"type": "string"
},
"orgUnitId": {
"description": "Organization Unit that we want to list the printers for. When org_unit is not present in the request then all printers of the customer are returned (or filtered). When org_unit is present in the request then only printers available to this OU will be returned (owned or inherited). You may see if printer is owned or inherited for this OU by looking at Printer.org_unit_id.",
"location": "query",
@@ -1357,7 +1367,7 @@
]
},
"list": {
"description": "Retrieve all groups of a domain or of a user given a userKey (paginated)",
"description": "Retrieves all groups of a domain or of a user given a userKey (paginated).",
"flatPath": "admin/directory/v1/groups",
"httpMethod": "GET",
"id": "directory.groups.list",
@@ -1369,7 +1379,7 @@
"type": "string"
},
"domain": {
"description": "The domain name. Use this field to get fields from only one domain. To return all domains for a customer account, use the `customer` query parameter instead.",
"description": "The domain name. Use this field to get groups from only one domain. To return all domains for a customer account, use the `customer` query parameter instead.",
"location": "query",
"type": "string"
},
@@ -1930,7 +1940,7 @@
]
},
"list": {
"description": "Retrieves a paginated list of all mobile devices for an account.",
"description": "Retrieves a paginated list of all user-owned mobile devices for an account. To retrieve a list that includes company-owned devices, use the Cloud Identity [Devices API](https://cloud.google.com/identity/docs/concepts/overview-devices) instead.",
"flatPath": "admin/directory/v1/customer/{customerId}/devices/mobile",
"httpMethod": "GET",
"id": "directory.mobiledevices.list",
@@ -2039,11 +2049,6 @@
"orgUnitPath"
],
"parameters": {
"allowPlus": {
"description": "Parses org unit path without url decode to allow for plus in ou name",
"location": "query",
"type": "boolean"
},
"customerId": {
"description": "The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](/admin-sdk/directory/v1/reference/users).",
"location": "path",
@@ -2051,7 +2056,7 @@
"type": "string"
},
"orgUnitPath": {
"description": "The full path of the organizational unit or its unique ID.",
"description": "The full path of the organizational unit (minus the leading `/`) or its unique ID.",
"location": "path",
"pattern": "^.*$",
"required": true,
@@ -2073,11 +2078,6 @@
"orgUnitPath"
],
"parameters": {
"allowPlus": {
"description": "Parses org unit path without url decode to allow for plus in ou name",
"location": "query",
"type": "boolean"
},
"customerId": {
"description": "The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](/admin-sdk/directory/v1/reference/users).",
"location": "path",
@@ -2085,7 +2085,7 @@
"type": "string"
},
"orgUnitPath": {
"description": "The full path of the organizational unit or its unique ID.",
"description": "The full path of the organizational unit (minus the leading `/`) or its unique ID.",
"location": "path",
"pattern": "^.*$",
"required": true,
@@ -2182,11 +2182,6 @@
"orgUnitPath"
],
"parameters": {
"allowPlus": {
"description": "Parses org unit path without url decode to allow for plus in ou name",
"location": "query",
"type": "boolean"
},
"customerId": {
"description": "The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](/admin-sdk/directory/v1/reference/users).",
"location": "path",
@@ -2194,7 +2189,7 @@
"type": "string"
},
"orgUnitPath": {
"description": "The full path of the organizational unit or its unique ID.",
"description": "The full path of the organizational unit (minus the leading `/`) or its unique ID.",
"location": "path",
"pattern": "^.*$",
"required": true,
@@ -2222,11 +2217,6 @@
"orgUnitPath"
],
"parameters": {
"allowPlus": {
"description": "Parses org unit path without url decode to allow for plus in ou name",
"location": "query",
"type": "boolean"
},
"customerId": {
"description": "The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](/admin-sdk/directory/v1/reference/users).",
"location": "path",
@@ -2234,7 +2224,7 @@
"type": "string"
},
"orgUnitPath": {
"description": "The full path of the organizational unit or its unique ID.",
"description": "The full path of the organizational unit (minus the leading `/`) or its unique ID.",
"location": "path",
"pattern": "^.*$",
"required": true,
@@ -2429,7 +2419,7 @@
]
},
"patch": {
"description": "Patches a building via Apiary Patch Orchestration.",
"description": "Patches a building.",
"flatPath": "admin/directory/v1/customer/{customer}/resources/buildings/{buildingId}",
"httpMethod": "PATCH",
"id": "directory.resources.buildings.patch",
@@ -2668,7 +2658,7 @@
]
},
"patch": {
"description": "Patches a calendar resource via Apiary Patch Orchestration.",
"description": "Patches a calendar resource.",
"flatPath": "admin/directory/v1/customer/{customer}/resources/calendars/{calendarResourceId}",
"httpMethod": "PATCH",
"id": "directory.resources.calendars.patch",
@@ -2865,7 +2855,7 @@
]
},
"patch": {
"description": "Patches a feature via Apiary Patch Orchestration.",
"description": "Patches a feature.",
"flatPath": "admin/directory/v1/customer/{customer}/resources/features/{featureKey}",
"httpMethod": "PATCH",
"id": "directory.resources.features.patch",
@@ -2998,7 +2988,7 @@
]
},
"get": {
"description": "Retrieve a role assignment.",
"description": "Retrieves a role assignment.",
"flatPath": "admin/directory/v1/customer/{customer}/roleassignments/{roleAssignmentId}",
"httpMethod": "GET",
"id": "directory.roleAssignments.get",
@@ -3234,7 +3224,7 @@
]
},
"patch": {
"description": "Patch role via Apiary Patch Orchestration",
"description": "Patches a role.",
"flatPath": "admin/directory/v1/customer/{customer}/roles/{roleId}",
"httpMethod": "PATCH",
"id": "directory.roles.patch",
@@ -3306,7 +3296,7 @@
"schemas": {
"methods": {
"delete": {
"description": "Delete schema",
"description": "Deletes a schema.",
"flatPath": "admin/directory/v1/customer/{customerId}/schemas/{schemaKey}",
"httpMethod": "DELETE",
"id": "directory.schemas.delete",
@@ -3334,7 +3324,7 @@
]
},
"get": {
"description": "Retrieve schema",
"description": "Retrieves a schema.",
"flatPath": "admin/directory/v1/customer/{customerId}/schemas/{schemaKey}",
"httpMethod": "GET",
"id": "directory.schemas.get",
@@ -3366,7 +3356,7 @@
]
},
"insert": {
"description": "Create schema.",
"description": "Creates a schema.",
"flatPath": "admin/directory/v1/customer/{customerId}/schemas",
"httpMethod": "POST",
"id": "directory.schemas.insert",
@@ -3393,7 +3383,7 @@
]
},
"list": {
"description": "Retrieve all schemas for a customer",
"description": "Retrieves all schemas for a customer.",
"flatPath": "admin/directory/v1/customer/{customerId}/schemas",
"httpMethod": "GET",
"id": "directory.schemas.list",
@@ -3418,7 +3408,7 @@
]
},
"patch": {
"description": "Patch Schema via Apiary Patch Orchestration",
"description": "Patches a schema.",
"flatPath": "admin/directory/v1/customer/{customerId}/schemas/{schemaKey}",
"httpMethod": "PATCH",
"id": "directory.schemas.patch",
@@ -3452,7 +3442,7 @@
]
},
"update": {
"description": "Update schema",
"description": "Updates a schema.",
"flatPath": "admin/directory/v1/customer/{customerId}/schemas/{schemaKey}",
"httpMethod": "PUT",
"id": "directory.schemas.update",
@@ -3490,7 +3480,7 @@
"tokens": {
"methods": {
"delete": {
"description": "Delete all access tokens issued by a user for an application.",
"description": "Deletes all access tokens issued by a user for an application.",
"flatPath": "admin/directory/v1/users/{userKey}/tokens/{clientId}",
"httpMethod": "DELETE",
"id": "directory.tokens.delete",
@@ -3518,7 +3508,7 @@
]
},
"get": {
"description": "Get information about an access token issued by a user.",
"description": "Gets information about an access token issued by a user.",
"flatPath": "admin/directory/v1/users/{userKey}/tokens/{clientId}",
"httpMethod": "GET",
"id": "directory.tokens.get",
@@ -3577,7 +3567,7 @@
"twoStepVerification": {
"methods": {
"turnOff": {
"description": "Turn off 2-Step Verification for user.",
"description": "Turns off 2-Step Verification for user.",
"flatPath": "admin/directory/v1/users/{userKey}/twoStepVerification/turnOff",
"httpMethod": "POST",
"id": "directory.twoStepVerification.turnOff",
@@ -3718,7 +3708,7 @@
"type": "string"
},
"domain": {
"description": "The domain name. Use this field to get fields from only one domain. To return all domains for a customer account, use the `customer` query parameter instead. Either the `customer` or the `domain` parameter must be provided.",
"description": "The domain name. Use this field to get groups from only one domain. To return all domains for a customer account, use the `customer` query parameter instead. Either the `customer` or the `domain` parameter must be provided.",
"location": "query",
"type": "string"
},
@@ -3797,7 +3787,7 @@
"type": "string"
},
"sortOrder": {
"description": "Whether to return results in ascending or descending order.",
"description": "Whether to return results in ascending or descending order, ignoring case.",
"enum": [
"ASCENDING",
"DESCENDING"
@@ -3886,7 +3876,7 @@
]
},
"signOut": {
"description": "Sign a user out of all web and device sessions and reset their sign-in cookies. User will have to sign in by authenticating again.",
"description": "Signs a user out of all web and device sessions and reset their sign-in cookies. User will have to sign in by authenticating again.",
"flatPath": "admin/directory/v1/users/{userKey}/signOut",
"httpMethod": "POST",
"id": "directory.users.signOut",
@@ -3958,7 +3948,7 @@
]
},
"watch": {
"description": "Watch for changes in users list",
"description": "Watches for changes in users list.",
"flatPath": "admin/directory/v1/users/watch",
"httpMethod": "POST",
"id": "directory.users.watch",
@@ -4164,6 +4154,19 @@
"userKey"
],
"parameters": {
"event": {
"description": "Events to watch for.",
"enum": [
"add",
"delete"
],
"enumDescriptions": [
"Alias Created Event",
"Alias Deleted Event"
],
"location": "query",
"type": "string"
},
"userKey": {
"description": "Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.",
"location": "path",
@@ -4183,7 +4186,7 @@
]
},
"watch": {
"description": "Watch for changes in users list.",
"description": "Watches for changes in users list.",
"flatPath": "admin/directory/v1/users/{userKey}/aliases/watch",
"httpMethod": "POST",
"id": "directory.users.aliases.watch",
@@ -4336,7 +4339,7 @@
"verificationCodes": {
"methods": {
"generate": {
"description": "Generate new backup verification codes for the user.",
"description": "Generates new backup verification codes for the user.",
"flatPath": "admin/directory/v1/users/{userKey}/verificationCodes/generate",
"httpMethod": "POST",
"id": "directory.verificationCodes.generate",
@@ -4357,7 +4360,7 @@
]
},
"invalidate": {
"description": "Invalidate the current backup verification codes for the user.",
"description": "Invalidates the current backup verification codes for the user.",
"flatPath": "admin/directory/v1/users/{userKey}/verificationCodes/invalidate",
"httpMethod": "POST",
"id": "directory.verificationCodes.invalidate",
@@ -4404,7 +4407,7 @@
}
}
},
"revision": "20210330",
"revision": "20220301",
"rootUrl": "https://admin.googleapis.com/",
"schemas": {
"Alias": {
@@ -4940,6 +4943,73 @@
"description": "The boot mode for the device. The possible values are: * `Verified`: The device is running a valid version of the Chrome OS. * `Dev`: The devices's developer hardware switch is enabled. When booted, the device has a command line shell. For an example of a developer switch, see the [Chromebook developer information](https://www.chromium.org/chromium-os/developer-information-for-chrome-os-devices/samsung-series-5-chromebook#TOC-Developer-switch).",
"type": "string"
},
"cpuInfo": {
"description": "Information regarding CPU specs in the device.",
"items": {
"description": "CPU specs for a CPU.",
"properties": {
"architecture": {
"description": "The CPU architecture.",
"type": "string"
},
"logicalCpus": {
"description": "Information for the Logical CPUs",
"items": {
"description": "Status of a single logical CPU.",
"properties": {
"cStates": {
"description": "C-States indicate the power consumption state of the CPU. For more information look at documentation published by the CPU maker.",
"items": {
"description": "Status of a single C-state. C-states are various modes the CPU can transition to in order to use more or less power.",
"properties": {
"displayName": {
"description": "Name of the state.",
"type": "string"
},
"sessionDuration": {
"description": "Time spent in the state since the last reboot.",
"format": "google-duration",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"currentScalingFrequencyKhz": {
"description": "Current frequency the CPU is running at.",
"format": "int32",
"type": "integer"
},
"idleDuration": {
"description": "Idle time since last boot.",
"format": "google-duration",
"type": "string"
},
"maxScalingFrequencyKhz": {
"description": "Maximum frequency the CPU is allowed to run at, by policy.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"type": "array"
},
"maxClockSpeedKhz": {
"description": "The max CPU clock speed in kHz.",
"format": "int32",
"type": "integer"
},
"model": {
"description": "The CPU model name.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"cpuStatusReports": {
"description": "Reports of CPU utilization and temperature (Read-only)",
"items": {
@@ -5118,8 +5188,12 @@
"description": "The device's order number. Only devices directly purchased from Google have an order number.",
"type": "string"
},
"orgUnitId": {
"description": "The unique ID of the organizational unit. orgUnitPath is the human readable version of orgUnitId. While orgUnitPath may change by renaming an organizational unit within the path, orgUnitId is unchangeable for one organizational unit. This property can be [updated](/admin-sdk/directory/v1/guides/manage-chrome-devices#move_chrome_devices_to_ou) using the API. For more information about how to create an organizational structure for your device, see the [administration help center](https://support.google.com/a/answer/182433).",
"type": "string"
},
"orgUnitPath": {
"description": "The full parent path with the organizational unit's name associated with the device. Path names are case insensitive. If the parent organizational unit is the top-level organization, it is represented as a forward slash, `/`. This property can be [updated](/admin-sdk/directory/v1/guides/manage-chrome-devices#update_chrome_device) using the API. For more information about how to create an organizational structure for your device, see the [administration help center](https://support.google.com/a/answer/182433).",
"description": "The full parent path with the organizational unit's name associated with the device. Path names are case insensitive. If the parent organizational unit is the top-level organization, it is represented as a forward slash, `/`. This property can be [updated](/admin-sdk/directory/v1/guides/manage-chrome-devices#move_chrome_devices_to_ou) using the API. For more information about how to create an organizational structure for your device, see the [administration help center](https://support.google.com/a/answer/182433).",
"type": "string"
},
"osVersion": {
@@ -5133,7 +5207,18 @@
"recentUsers": {
"description": "List of recent device users, in descending order, by last login time.",
"items": {
"$ref": "RecentUsers"
"description": "List of recent device users, in descending order, by last login time.",
"properties": {
"email": {
"description": "The user's email address. This is only present if the user type is `USER_TYPE_MANAGED`.",
"type": "string"
},
"type": {
"description": "The type of the user.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
@@ -5717,7 +5802,7 @@
"The caller does not have permission to execute the specified operation. `PERMISSION_DENIED` must not be used for rejections caused by exhausting some resource (use `RESOURCE_EXHAUSTED` instead for those errors). `PERMISSION_DENIED` must not be used if the caller can not be identified (use `UNAUTHENTICATED` instead for those errors). This error code does not imply the request is valid or the requested entity exists or satisfies other pre-conditions. HTTP Mapping: 403 Forbidden",
"The request does not have valid authentication credentials for the operation. HTTP Mapping: 401 Unauthorized",
"Some resource has been exhausted, perhaps a per-user quota, or perhaps the entire file system is out of space. HTTP Mapping: 429 Too Many Requests",
"The operation was rejected because the system is not in a state required for the operation's execution. For example, the directory to be deleted is non-empty, an rmdir operation is applied to a non-directory, etc. Service implementors can use the following guidelines to decide between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`: (a) Use `UNAVAILABLE` if the client can retry just the failing call. (b) Use `ABORTED` if the client should retry at a higher level (e.g., when a client-specified test-and-set fails, indicating the client should restart a read-modify-write sequence). (c) Use `FAILED_PRECONDITION` if the client should not retry until the system state has been explicitly fixed. E.g., if an \"rmdir\" fails because the directory is non-empty, `FAILED_PRECONDITION` should be returned since the client should not retry unless the files are deleted from the directory. HTTP Mapping: 400 Bad Request",
"The operation was rejected because the system is not in a state required for the operation's execution. For example, the directory to be deleted is non-empty, an rmdir operation is applied to a non-directory, etc. Service implementors can use the following guidelines to decide between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`: (a) Use `UNAVAILABLE` if the client can retry just the failing call. (b) Use `ABORTED` if the client should retry at a higher level. For example, when a client-specified test-and-set fails, indicating the client should restart a read-modify-write sequence. (c) Use `FAILED_PRECONDITION` if the client should not retry until the system state has been explicitly fixed. For example, if an \"rmdir\" fails because the directory is non-empty, `FAILED_PRECONDITION` should be returned since the client should not retry unless the files are deleted from the directory. HTTP Mapping: 400 Bad Request",
"The operation was aborted, typically due to a concurrency issue such as a sequencer check failure or transaction abort. See the guidelines above for deciding between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`. HTTP Mapping: 409 Conflict",
"The operation was attempted past the valid range. E.g., seeking or reading past end-of-file. Unlike `INVALID_ARGUMENT`, this error indicates a problem that may be fixed if the system state changes. For example, a 32-bit file system will generate `INVALID_ARGUMENT` if asked to read at an offset that is not in the range [0,2^32-1], but it will generate `OUT_OF_RANGE` if asked to read from an offset past the current file size. There is a fair bit of overlap between `FAILED_PRECONDITION` and `OUT_OF_RANGE`. We recommend using `OUT_OF_RANGE` (the more specific error) when it applies so that callers who are iterating through a space can easily look for an `OUT_OF_RANGE` error to detect when they are done. HTTP Mapping: 400 Bad Request",
"The operation is not implemented or is not supported/enabled in this service. HTTP Mapping: 501 Not Implemented",
@@ -5933,7 +6018,7 @@
"type": "string"
},
"printers": {
"description": "List of printers. If `org_unit_id` was given in the request, then only printers visible for this OU will be returned. If `org_unit_id` was given in the request, then all printers will be returned.",
"description": "List of printers. If `org_unit_id` was given in the request, then only printers visible for this OU will be returned. If `org_unit_id` was not given in the request, then all printers will be returned.",
"items": {
"$ref": "Printer"
},
@@ -6271,7 +6356,7 @@
"type": "object"
},
"OrgUnit": {
"description": "Managing your account's organizational units allows you to configure your users' access to services and custom settings. For more information about common organizational unit tasks, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-org-units.html).",
"description": "Managing your account's organizational units allows you to configure your users' access to services and custom settings. For more information about common organizational unit tasks, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-org-units.html). The customer's organizational unit hierarchy is limited to 35 levels of depth.",
"id": "OrgUnit",
"properties": {
"blockInheritance": {
@@ -6473,21 +6558,6 @@
},
"type": "object"
},
"RecentUsers": {
"description": "List of recent device users, in descending order, by last login time.",
"id": "RecentUsers",
"properties": {
"email": {
"description": "The user's email address. This is only present if the user type is `USER_TYPE_MANAGED`.",
"type": "string"
},
"type": {
"description": "The type of the user.",
"type": "string"
}
},
"type": "object"
},
"Role": {
"id": "Role",
"properties": {
@@ -6552,6 +6622,7 @@
"type": "object"
},
"RoleAssignment": {
"description": "Defines an assignment of a role.",
"id": "RoleAssignment",
"properties": {
"assignedTo": {
@@ -6683,7 +6754,7 @@
"directory.schemas.insert"
]
},
"description": "The schema's name.",
"description": "The schema's name. Each `schema_name` must be unique within a customer. Reusing a name results in a `409: Entity already exists` error.",
"type": "string"
}
},
@@ -6872,7 +6943,7 @@
"type": "boolean"
},
"aliases": {
"description": "Output only. List of the user's alias email addresses.",
"description": "Output only. A list of the user's alias email addresses.",
"items": {
"type": "string"
},
@@ -6897,7 +6968,7 @@
"additionalProperties": {
"$ref": "UserCustomProperties"
},
"description": "Custom fields of the user.",
"description": "Custom fields of the user. The key is a `schema_name` and its values are `'field_name': 'field_value'`.",
"type": "object"
},
"customerId": {
@@ -6928,7 +6999,7 @@
"type": "any"
},
"hashFunction": {
"description": "Stores the hash format of the password property. We recommend sending the `password` property value as a base 16 bit hexadecimal-encoded hash value. Set the `hashFunction` values as either the [SHA-1](https://wikipedia.org/wiki/SHA-1), [MD5](https://wikipedia.org/wiki/MD5), or [crypt](https://en.wikipedia.org/wiki/Crypt_\\(C\\)) hash format.",
"description": "Stores the hash format of the password property. We recommend sending the `password` property value as a base 16 bit hexadecimal-encoded hash value. The following `hashFunction` values are allowed: * `DES` * `MD5` - hash prefix is `$1$` * `SHA2-256` - hash prefix is `$5$` * `SHA2-512` - hash prefix is `$6$` If rounds are specified as part of the prefix, they must be 10,000 or fewer.",
"type": "string"
},
"id": {
@@ -7290,11 +7361,15 @@
"id": "UserLanguage",
"properties": {
"customLanguage": {
"description": "Other language. User can provide own language name if there is no corresponding Google III language code. If this is set LanguageCode can't be set",
"description": "Other language. User can provide their own language name if there is no corresponding ISO 639 language code. If this is set, `languageCode` can't be set.",
"type": "string"
},
"languageCode": {
"description": "Language Code. Should be used for storing Google III LanguageCode string representation for language. Illegal values cause SchemaException.",
"description": "ISO 639 string representation of a language. See [Language Codes](/admin-sdk/directory/v1/languages) for the list of supported codes. Valid language codes outside the supported set will be accepted by the API but may lead to unexpected behavior. Illegal values cause `SchemaException`. If this is set, `customLanguage` can't be set.",
"type": "string"
},
"preference": {
"description": "Optional. If present, controls whether the specified `languageCode` is the user's preferred language. If `customLanguage` is set, this can't be set. Allowed values are `preferred` and `not_preferred`.",
"type": "string"
}
},

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

@@ -17,7 +17,7 @@
"canonicalName": "reports",
"description": "Admin SDK lets administrators of enterprise domains to view and manage resources like user, groups etc. It also provides audit and usage reports of domain.",
"discoveryVersion": "v1",
"documentationLink": "http://developers.google.com/admin-sdk/",
"documentationLink": "https://developers.google.com/admin-sdk/",
"fullyEncodeReservedExpansion": true,
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
@@ -148,7 +148,8 @@
"user_accounts",
"context_aware_access",
"chrome",
"data_studio"
"data_studio",
"keep"
],
"enumDescriptions": [
"The Google Workspace Access Transparency activity reports return information about different types of Access Transparency activity events.",
@@ -162,18 +163,19 @@
"The Enterprise Groups activity reports return information about various Enterprise group activity events.",
"The Jamboard activity reports return information about various Jamboard activity events.",
"The Login application's activity reports return account information about different types of Login activity events.",
"The Meet Audit activity report return information about different types of Meet Audit activity events.",
"The Mobile Audit activity report return information about different types of Mobile Audit activity events.",
"The Rules activity report return information about different types of Rules activity events.",
"The SAML activity report return information about different types of SAML activity events.",
"The Meet Audit activity report returns information about different types of Meet Audit activity events.",
"The Device Audit activity report returns information about different types of Device Audit activity events.",
"The Rules activity report returns information about different types of Rules activity events.",
"The SAML activity report returns information about different types of SAML activity events.",
"The Token application's activity reports return account information about different types of Token activity events.",
"The User Accounts application's activity reports return account information about different types of User Accounts activity events.",
"The Context-aware access activity reports return information about users' access denied events due to Context-aware access rules.",
"The Chrome activity reports return information about unsafe events reported in the context of the WebProtect features of BeyondCorp.",
"The Data Studio activity reports return information about various types of Data Studio activity events."
"The Chrome activity reports return information about Chrome browser and Chrome OS events.",
"The Data Studio activity reports return information about various types of Data Studio activity events.",
"The Keep application's activity reports return information about various Google Keep activity events. The Keep activity report is only available for Google Workspace Business and Enterprise customers."
],
"location": "path",
"pattern": "(access_transparency)|(admin)|(calendar)|(chat)|(chrome)|(context_aware_access)|(data_studio)|(drive)|(gcp)|(gplus)|(groups)|(groups_enterprise)|(jamboard)|(login)|(meet)|(mobile)|(rules)|(saml)|(token)|(user_accounts)",
"pattern": "(access_transparency)|(admin)|(calendar)|(chat)|(chrome)|(context_aware_access)|(data_studio)|(drive)|(gcp)|(gplus)|(groups)|(groups_enterprise)|(jamboard)|(keep)|(login)|(meet)|(mobile)|(rules)|(saml)|(token)|(user_accounts)",
"required": true,
"type": "string"
},
@@ -201,7 +203,7 @@
"type": "string"
},
"groupIdFilter": {
"description": "Comma separated group ids (obfuscated) on which user activities are filtered, i.e, the response will contain activities for only those users that are a part of at least one of the group ids mentioned here. Format: \"id:abc123,id:xyz456\"",
"description": "Comma separated group ids (obfuscated) on which user activities are filtered, i.e. the response will contain activities for only those users that are a part of at least one of the group ids mentioned here. Format: \"id:abc123,id:xyz456\"",
"location": "query",
"pattern": "(id:[a-z0-9]+(,id:[a-z0-9]+)*)",
"type": "string"
@@ -234,7 +236,7 @@
"type": "string"
},
"userKey": {
"description": "Represents the profile ID or the user email for which the data should be filtered. Can be `all` for all information, or `userKey` for a user's unique Google Workspace profile ID or their primary email address.",
"description": "Represents the profile ID or the user email for which the data should be filtered. Can be `all` for all information, or `userKey` for a user's unique Google Workspace profile ID or their primary email address. Must not be a deleted user. For a deleted user, call `users.list` in Directory API with `showDeleted=true`, then use the returned `ID` as the `userKey`.",
"location": "path",
"required": true,
"type": "string"
@@ -285,7 +287,8 @@
"user_accounts",
"context_aware_access",
"chrome",
"data_studio"
"data_studio",
"keep"
],
"enumDescriptions": [
"The Google Workspace Access Transparency activity reports return information about different types of Access Transparency activity events.",
@@ -299,18 +302,19 @@
"The Enterprise Groups activity reports return information about various Enterprise group activity events.",
"The Jamboard activity reports return information about various Jamboard activity events.",
"The Login application's activity reports return account information about different types of Login activity events.",
"The Meet Audit activity report return information about different types of Meet Audit activity events.",
"The Mobile Audit activity report return information about different types of Mobile Audit activity events.",
"The Rules activity report return information about different types of Rules activity events.",
"The SAML activity report return information about different types of SAML activity events.",
"The Meet Audit activity report returns information about different types of Meet Audit activity events.",
"The Device Audit activity report returns information about different types of Device Audit activity events.",
"The Rules activity report returns information about different types of Rules activity events.",
"The SAML activity report returns information about different types of SAML activity events.",
"The Token application's activity reports return account information about different types of Token activity events.",
"The User Accounts application's activity reports return account information about different types of User Accounts activity events.",
"The Context-aware access activity reports return information about users' access denied events due to Context-aware access rules.",
"The Chrome activity reports return information about unsafe events reported in the context of the WebProtect features of BeyondCorp.",
"The Data Studio activity reports return information about various types of Data Studio activity events."
"The Chrome activity reports return information about Chrome browser and Chrome OS events.",
"The Data Studio activity reports return information about various types of Data Studio activity events.",
"The Keep application's activity reports return information about various Google Keep activity events. The Keep activity report is only available for Google Workspace Business and Enterprise customers."
],
"location": "path",
"pattern": "(access_transparency)|(admin)|(calendar)|(chat)|(chrome)|(context_aware_access)|(data_studio)|(drive)|(gcp)|(gplus)|(groups)|(groups_enterprise)|(jamboard)|(login)|(meet)|(mobile)|(rules)|(saml)|(token)|(user_accounts)",
"pattern": "(access_transparency)|(admin)|(calendar)|(chat)|(chrome)|(context_aware_access)|(data_studio)|(drive)|(gcp)|(gplus)|(groups)|(groups_enterprise)|(jamboard)|(keep)|(login)|(meet)|(mobile)|(rules)|(saml)|(token)|(user_accounts)",
"required": true,
"type": "string"
},
@@ -338,7 +342,7 @@
"type": "string"
},
"groupIdFilter": {
"description": "Comma separated group ids (obfuscated) on which user activities are filtered, i.e, the response will contain activities for only those users that are a part of at least one of the group ids mentioned here. Format: \"id:abc123,id:xyz456\"",
"description": "Comma separated group ids (obfuscated) on which user activities are filtered, i.e. the response will contain activities for only those users that are a part of at least one of the group ids mentioned here. Format: \"id:abc123,id:xyz456\"",
"location": "query",
"pattern": "(id:[a-z0-9]+(,id:[a-z0-9]+)*)",
"type": "string"
@@ -371,7 +375,7 @@
"type": "string"
},
"userKey": {
"description": "Represents the profile ID or the user email for which the data should be filtered. Can be `all` for all information, or `userKey` for a user's unique Google Workspace profile ID or their primary email address.",
"description": "Represents the profile ID or the user email for which the data should be filtered. Can be `all` for all information, or `userKey` for a user's unique Google Workspace profile ID or their primary email address. Must not be a deleted user. For a deleted user, call `users.list` in Directory API with `showDeleted=true`, then use the returned `ID` as the `userKey`.",
"location": "path",
"required": true,
"type": "string"
@@ -482,15 +486,7 @@
"type": "string"
},
"entityKey": {
"description": "Represents the key of the object to filter the data with.",
"enum": [
"all",
"entityKey"
],
"enumDescriptions": [
"Returns activity events for all users.",
"Represents an app-specific identifier for the entity. For details on how to obtain the `entityKey` for a particular `entityType`, see the Entities Usage parameters reference guides."
],
"description": "Represents the key of the object to filter the data with. It is a string which can take the value `all` to get activity events for all users, or any other value for an app-specific entity. For details on how to obtain the `entityKey` for a particular `entityType`, see the Entities Usage parameters reference guides.",
"location": "path",
"required": true,
"type": "string"
@@ -577,7 +573,7 @@
"type": "string"
},
"groupIdFilter": {
"description": "Comma separated group ids (obfuscated) on which user activities are filtered, i.e, the response will contain activities for only those users that are a part of at least one of the group ids mentioned here. Format: \"id:abc123,id:xyz456\"",
"description": "Comma separated group ids (obfuscated) on which user activities are filtered, i.e. the response will contain activities for only those users that are a part of at least one of the group ids mentioned here. Format: \"id:abc123,id:xyz456\"",
"location": "query",
"pattern": "(id:[a-z0-9]+(,id:[a-z0-9]+)*)",
"type": "string"
@@ -610,7 +606,7 @@
"type": "string"
},
"userKey": {
"description": "Represents the profile ID or the user email for which the data should be filtered. Can be `all` for all information, or `userKey` for a user's unique Google Workspace profile ID or their primary email address.",
"description": "Represents the profile ID or the user email for which the data should be filtered. Can be `all` for all information, or `userKey` for a user's unique Google Workspace profile ID or their primary email address. Must not be a deleted user. For a deleted user, call `users.list` in Directory API with `showDeleted=true`, then use the returned `ID` as the `userKey`.",
"location": "path",
"required": true,
"type": "string"
@@ -627,7 +623,7 @@
}
}
},
"revision": "20210330",
"revision": "20220301",
"rootUrl": "https://admin.googleapis.com/",
"schemas": {
"Activities": {
@@ -677,7 +673,7 @@
"type": "string"
},
"profileId": {
"description": "The unique Google Workspace profile ID of the actor. May be absent if the actor is not a Google Workspace user.",
"description": "The unique Google Workspace profile ID of the actor. This value might be absent if the actor is not a Google Workspace user, or may be the number 105250506097979753968 which acts as a placeholder ID.",
"type": "string"
}
},

328
etc/api/admob/v1/admob-api.json
View File

@@ -168,6 +168,88 @@
}
},
"resources": {
"adUnits": {
"methods": {
"list": {
"description": "List the ad units under the specified AdMob account.",
"flatPath": "v1/accounts/{accountsId}/adUnits",
"httpMethod": "GET",
"id": "admob.accounts.adUnits.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "The maximum number of ad units to return. If unspecified or 0, at most 1000 ad units will be returned. The maximum value is 10,000; values above 10,000 will be coerced to 10,000.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The value returned by the last `ListAdUnitsResponse`; indicates that this is a continuation of a prior `ListAdUnits` call, and that the system should return the next page of data.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. Resource name of the account to list ad units for. Example: accounts/pub-9876543210987654",
"location": "path",
"pattern": "^accounts/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/adUnits",
"response": {
"$ref": "ListAdUnitsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/admob.readonly"
],
"streamingType": "NONE"
}
}
},
"apps": {
"methods": {
"list": {
"description": "List the apps under the specified AdMob account.",
"flatPath": "v1/accounts/{accountsId}/apps",
"httpMethod": "GET",
"id": "admob.accounts.apps.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "The maximum number of apps to return. If unspecified or 0, at most 1000 apps will be returned. The maximum value is 10,000; values above 10,000 will be coerced to 10,000.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The value returned by the last `ListAppsResponse`; indicates that this is a continuation of a prior `ListApps` call, and that the system should return the next page of data.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. Resource name of the account to list apps for. Example: accounts/pub-9876543210987654",
"location": "path",
"pattern": "^accounts/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/apps",
"response": {
"$ref": "ListAppsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/admob.readonly"
],
"streamingType": "NONE"
}
}
},
"mediationReport": {
"methods": {
"generate": {
@@ -239,11 +321,99 @@
}
}
},
"revision": "20210331",
"revision": "20220303",
"rootUrl": "https://admob.googleapis.com/",
"schemas": {
"AdUnit": {
"description": "Describes an AdMob ad unit.",
"id": "AdUnit",
"properties": {
"adFormat": {
"description": "AdFormat of the ad unit. Possible values are as follows: \"BANNER\" - Banner ad format. \"BANNER_INTERSTITIAL\" - Legacy format that can be used as either banner or interstitial. This format can no longer be created but can be targeted by mediation groups. \"INTERSTITIAL\" - A full screen ad. Supported ad types are \"RICH_MEDIA\" and \"VIDEO\". \"NATIVE\" - Native ad format. \"REWARDED\" - An ad that, once viewed, gets a callback verifying the view so that a reward can be given to the user. Supported ad types are \"RICH_MEDIA\" (interactive) and video where video can not be excluded.",
"type": "string"
},
"adTypes": {
"description": "Ad media type supported by this ad unit. Possible values as follows: \"RICH_MEDIA\" - Text, image, and other non-video media. \"VIDEO\" - Video media.",
"items": {
"type": "string"
},
"type": "array"
},
"adUnitId": {
"description": "The externally visible ID of the ad unit which can be used to integrate with the AdMob SDK. This is a read only property. Example: ca-app-pub-9876543210987654/0123456789",
"type": "string"
},
"appId": {
"description": "The externally visible ID of the app this ad unit is associated with. Example: ca-app-pub-9876543210987654~0123456789",
"type": "string"
},
"displayName": {
"description": "The display name of the ad unit as shown in the AdMob UI, which is provided by the user. The maximum length allowed is 80 characters.",
"type": "string"
},
"name": {
"description": "Resource name for this ad unit. Format is accounts/{publisher_id}/adUnits/{ad_unit_id_fragment} Example: accounts/pub-9876543210987654/adUnits/0123456789",
"type": "string"
}
},
"type": "object"
},
"App": {
"description": "Describes an AdMob app for a specific platform (For example: Android or iOS).",
"id": "App",
"properties": {
"appId": {
"description": "The externally visible ID of the app which can be used to integrate with the AdMob SDK. This is a read only property. Example: ca-app-pub-9876543210987654~0123456789",
"type": "string"
},
"linkedAppInfo": {
"$ref": "AppLinkedAppInfo",
"description": "Immutable. The information for an app that is linked to an app store. This field is present if and only if the app is linked to an app store."
},
"manualAppInfo": {
"$ref": "AppManualAppInfo",
"description": "The information for an app that is not linked to any app store. After an app is linked, this information is still retrivable. If no name is provided for the app upon creation, a placeholder name will be used."
},
"name": {
"description": "Resource name for this app. Format is accounts/{publisher_id}/apps/{app_id_fragment} Example: accounts/pub-9876543210987654/apps/0123456789",
"type": "string"
},
"platform": {
"description": "Describes the platform of the app. Limited to \"IOS\" and \"ANDROID\".",
"type": "string"
}
},
"type": "object"
},
"AppLinkedAppInfo": {
"description": "Information from the app store if the app is linked to an app store.",
"id": "AppLinkedAppInfo",
"properties": {
"appStoreId": {
"description": "The app store ID of the app; present if and only if the app is linked to an app store. If the app is added to the Google Play store, it will be the application ID of the app. For example: \"com.example.myapp\". See https://developer.android.com/studio/build/application-id. If the app is added to the Apple App Store, it will be app store ID. For example \"105169111\". Note that setting the app store id is considered an irreversible action. Once an app is linked, it cannot be unlinked.",
"type": "string"
},
"displayName": {
"description": "Output only. Display name of the app as it appears in the app store. This is an output-only field, and may be empty if the app cannot be found in the store.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"AppManualAppInfo": {
"description": "Information provided for manual apps which are not linked to an application store (Example: Google Play, App Store).",
"id": "AppManualAppInfo",
"properties": {
"displayName": {
"description": "The display name of the app as shown in the AdMob UI, which is provided by the user. The maximum length allowed is 80 characters.",
"type": "string"
}
},
"type": "object"
},
"Date": {
"description": "Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.",
"description": "Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp",
"id": "Date",
"properties": {
"day": {
@@ -339,6 +509,42 @@
},
"type": "object"
},
"ListAdUnitsResponse": {
"description": "Response for the ad units list request.",
"id": "ListAdUnitsResponse",
"properties": {
"adUnits": {
"description": "The resulting ad units for the requested account.",
"items": {
"$ref": "AdUnit"
},
"type": "array"
},
"nextPageToken": {
"description": "If not empty, indicates that there may be more ad units for the request; this value should be passed in a new `ListAdUnitsRequest`.",
"type": "string"
}
},
"type": "object"
},
"ListAppsResponse": {
"description": "Response for the apps list request.",
"id": "ListAppsResponse",
"properties": {
"apps": {
"description": "The resulting apps for the requested account.",
"items": {
"$ref": "App"
},
"type": "array"
},
"nextPageToken": {
"description": "If not empty, indicates that there may be more apps for the request; this value should be passed in a new `ListAppsRequest`.",
"type": "string"
}
},
"type": "object"
},
"ListPublisherAccountsResponse": {
"description": "Response for the publisher account list request.",
"id": "ListPublisherAccountsResponse",
@@ -373,7 +579,7 @@
"type": "object"
},
"MediationReportSpec": {
"description": "The specification for generating an AdMob Mediation report. For example, the specification to get observed ECPM sliced by ad source and app for the 'US' and 'CN' countries can look like the following example: { \"date_range\": { \"start_date\": {\"year\": 2018, \"month\": 9, \"day\": 1}, \"end_date\": {\"year\": 2018, \"month\": 9, \"day\": 30} }, \"dimensions\": [\"AD_SOURCE\", \"APP\", \"COUNTRY\"], \"metrics\": [\"OBSERVED_ECPM\"], \"dimension_filters\": [ { \"dimension\": \"COUNTRY\", \"matches_any\": {\"values\": [{\"value\": \"US\", \"value\": \"CN\"}]} } ], \"sort_conditions\": [ {\"dimension\":\"APP\", order: \"ASCENDING\"} ], \"localization_settings\": { \"currency_code\": \"USD\", \"language_code\": \"en-US\" } } For a better understanding, you can treat the preceding specification like the following pseudo SQL: SELECT AD_SOURCE, APP, COUNTRY, OBSERVED_ECPM FROM MEDIATION_REPORT WHERE DATE >= '2018-09-01' AND DATE <= '2018-09-30' AND COUNTRY IN ('US', 'CN') GROUP BY AD_SOURCE, APP, COUNTRY ORDER BY APP ASC;",
"description": "The specification for generating an AdMob Mediation report. For example, the specification to get observed ECPM sliced by ad source and app for the 'US' and 'CN' countries can look like the following example: { \"date_range\": { \"start_date\": {\"year\": 2021, \"month\": 9, \"day\": 1}, \"end_date\": {\"year\": 2021, \"month\": 9, \"day\": 30} }, \"dimensions\": [\"AD_SOURCE\", \"APP\", \"COUNTRY\"], \"metrics\": [\"OBSERVED_ECPM\"], \"dimension_filters\": [ { \"dimension\": \"COUNTRY\", \"matches_any\": {\"values\": [{\"value\": \"US\", \"value\": \"CN\"}]} } ], \"sort_conditions\": [ {\"dimension\":\"APP\", order: \"ASCENDING\"} ], \"localization_settings\": { \"currency_code\": \"USD\", \"language_code\": \"en-US\" } } For a better understanding, you can treat the preceding specification like the following pseudo SQL: SELECT AD_SOURCE, APP, COUNTRY, OBSERVED_ECPM FROM MEDIATION_REPORT WHERE DATE >= '2021-09-01' AND DATE <= '2021-09-30' AND COUNTRY IN ('US', 'CN') GROUP BY AD_SOURCE, APP, COUNTRY ORDER BY APP ASC;",
"id": "MediationReportSpec",
"properties": {
"dateRange": {
@@ -402,21 +608,29 @@
"MEDIATION_GROUP",
"COUNTRY",
"FORMAT",
"PLATFORM"
"PLATFORM",
"MOBILE_OS_VERSION",
"GMA_SDK_VERSION",
"APP_VERSION_NAME",
"SERVING_RESTRICTION"
],
"enumDescriptions": [
"Default value for an unset field. Do not use.",
"A date in the YYYY-MM-DD format (for example, \"2018-12-21\"). Requests can specify at most one time dimension.",
"A month in the YYYY-MM format (for example, \"2018-12\"). Requests can specify at most one time dimension.",
"The date of the first day of a week in the YYYY-MM-DD format (for example, \"2018-12-21\"). Requests can specify at most one time dimension.",
"A date in the YYYYMMDD format (for example, \"20210701\"). Requests can specify at most one time dimension.",
"A month in the YYYYMM format (for example, \"202107\"). Requests can specify at most one time dimension.",
"The date of the first day of a week in the YYYYMMDD format (for example, \"20210701\"). Requests can specify at most one time dimension.",
"The [unique ID of the ad source](/admob/api/v1/ad_sources) (for example, \"5450213213286189855\" and \"AdMob Network\" as label value).",
"The unique ID of the ad source instance (for example, \"ca-app-pub-1234#5678\" and \"AdMob (default)\" as label value).",
"The unique ID of the ad source instance (for example, \"ca-app-pub-1234:asi:5678\" and \"AdMob (default)\" as label value).",
"The unique ID of the ad unit (for example, \"ca-app-pub-1234/8790\"). If AD_UNIT dimension is specified, then APP is included automatically.",
"The unique ID of the mobile application (for example, \"ca-app-pub-1234~1234\").",
"The unique ID of the mediation group (for example, \"ca-app-pub-1234:mg:1234\" and \"AdMob (default)\" as label value).",
"CLDR country code of the place where the ad views/clicks occur (for example, \"US\" or \"FR\"). This is a geography dimension.",
"Format of the ad unit (for example, \"banner\", \"native\"), an ad delivery dimension.",
"Mobile OS platform of the app (for example, \"Android\" or \"iOS\")."
"Mobile OS platform of the app (for example, \"Android\" or \"iOS\").",
"Mobile operating system version, e.g. \"iOS 13.5.1\". **Warning:** The dimension is incompatible with [ESTIMATED_EARNINGS](#Metric.ENUM_VALUES.ESTIMATED_EARNINGS), [OBSERVED_ECPM](#Metric.ENUM_VALUES.OBSERVED_ECPM) metrics.",
"GMA SDK version, e.g. \"iOS 7.62.0\". **Warning:** The dimension is incompatible with [ESTIMATED_EARNINGS](#Metric.ENUM_VALUES.ESTIMATED_EARNINGS), [OBSERVED_ECPM](#Metric.ENUM_VALUES.OBSERVED_ECPM) metrics.",
"For Android, the app version name can be found in versionName in PackageInfo. For iOS, the app version name can be found in CFBundleShortVersionString. **Warning:** The dimension is incompatible with [ESTIMATED_EARNINGS](#Metric.ENUM_VALUES.ESTIMATED_EARNINGS), [OBSERVED_ECPM](#Metric.ENUM_VALUES.OBSERVED_ECPM) metrics.",
"Restriction mode for ads serving (e.g. \"Non-personalized ads\"). **Warning:** The dimension is incompatible with [ESTIMATED_EARNINGS](#Metric.ENUM_VALUES.ESTIMATED_EARNINGS) metric."
],
"type": "string"
},
@@ -492,21 +706,29 @@
"MEDIATION_GROUP",
"COUNTRY",
"FORMAT",
"PLATFORM"
"PLATFORM",
"MOBILE_OS_VERSION",
"GMA_SDK_VERSION",
"APP_VERSION_NAME",
"SERVING_RESTRICTION"
],
"enumDescriptions": [
"Default value for an unset field. Do not use.",
"A date in the YYYY-MM-DD format (for example, \"2018-12-21\"). Requests can specify at most one time dimension.",
"A month in the YYYY-MM format (for example, \"2018-12\"). Requests can specify at most one time dimension.",
"The date of the first day of a week in the YYYY-MM-DD format (for example, \"2018-12-21\"). Requests can specify at most one time dimension.",
"A date in the YYYYMMDD format (for example, \"20210701\"). Requests can specify at most one time dimension.",
"A month in the YYYYMM format (for example, \"202107\"). Requests can specify at most one time dimension.",
"The date of the first day of a week in the YYYYMMDD format (for example, \"20210701\"). Requests can specify at most one time dimension.",
"The [unique ID of the ad source](/admob/api/v1/ad_sources) (for example, \"5450213213286189855\" and \"AdMob Network\" as label value).",
"The unique ID of the ad source instance (for example, \"ca-app-pub-1234#5678\" and \"AdMob (default)\" as label value).",
"The unique ID of the ad source instance (for example, \"ca-app-pub-1234:asi:5678\" and \"AdMob (default)\" as label value).",
"The unique ID of the ad unit (for example, \"ca-app-pub-1234/8790\"). If AD_UNIT dimension is specified, then APP is included automatically.",
"The unique ID of the mobile application (for example, \"ca-app-pub-1234~1234\").",
"The unique ID of the mediation group (for example, \"ca-app-pub-1234:mg:1234\" and \"AdMob (default)\" as label value).",
"CLDR country code of the place where the ad views/clicks occur (for example, \"US\" or \"FR\"). This is a geography dimension.",
"Format of the ad unit (for example, \"banner\", \"native\"), an ad delivery dimension.",
"Mobile OS platform of the app (for example, \"Android\" or \"iOS\")."
"Mobile OS platform of the app (for example, \"Android\" or \"iOS\").",
"Mobile operating system version, e.g. \"iOS 13.5.1\". **Warning:** The dimension is incompatible with [ESTIMATED_EARNINGS](#Metric.ENUM_VALUES.ESTIMATED_EARNINGS), [OBSERVED_ECPM](#Metric.ENUM_VALUES.OBSERVED_ECPM) metrics.",
"GMA SDK version, e.g. \"iOS 7.62.0\". **Warning:** The dimension is incompatible with [ESTIMATED_EARNINGS](#Metric.ENUM_VALUES.ESTIMATED_EARNINGS), [OBSERVED_ECPM](#Metric.ENUM_VALUES.OBSERVED_ECPM) metrics.",
"For Android, the app version name can be found in versionName in PackageInfo. For iOS, the app version name can be found in CFBundleShortVersionString. **Warning:** The dimension is incompatible with [ESTIMATED_EARNINGS](#Metric.ENUM_VALUES.ESTIMATED_EARNINGS), [OBSERVED_ECPM](#Metric.ENUM_VALUES.OBSERVED_ECPM) metrics.",
"Restriction mode for ads serving (e.g. \"Non-personalized ads\"). **Warning:** The dimension is incompatible with [ESTIMATED_EARNINGS](#Metric.ENUM_VALUES.ESTIMATED_EARNINGS) metric."
],
"type": "string"
},
@@ -535,21 +757,29 @@
"MEDIATION_GROUP",
"COUNTRY",
"FORMAT",
"PLATFORM"
"PLATFORM",
"MOBILE_OS_VERSION",
"GMA_SDK_VERSION",
"APP_VERSION_NAME",
"SERVING_RESTRICTION"
],
"enumDescriptions": [
"Default value for an unset field. Do not use.",
"A date in the YYYY-MM-DD format (for example, \"2018-12-21\"). Requests can specify at most one time dimension.",
"A month in the YYYY-MM format (for example, \"2018-12\"). Requests can specify at most one time dimension.",
"The date of the first day of a week in the YYYY-MM-DD format (for example, \"2018-12-21\"). Requests can specify at most one time dimension.",
"A date in the YYYYMMDD format (for example, \"20210701\"). Requests can specify at most one time dimension.",
"A month in the YYYYMM format (for example, \"202107\"). Requests can specify at most one time dimension.",
"The date of the first day of a week in the YYYYMMDD format (for example, \"20210701\"). Requests can specify at most one time dimension.",
"The [unique ID of the ad source](/admob/api/v1/ad_sources) (for example, \"5450213213286189855\" and \"AdMob Network\" as label value).",
"The unique ID of the ad source instance (for example, \"ca-app-pub-1234#5678\" and \"AdMob (default)\" as label value).",
"The unique ID of the ad source instance (for example, \"ca-app-pub-1234:asi:5678\" and \"AdMob (default)\" as label value).",
"The unique ID of the ad unit (for example, \"ca-app-pub-1234/8790\"). If AD_UNIT dimension is specified, then APP is included automatically.",
"The unique ID of the mobile application (for example, \"ca-app-pub-1234~1234\").",
"The unique ID of the mediation group (for example, \"ca-app-pub-1234:mg:1234\" and \"AdMob (default)\" as label value).",
"CLDR country code of the place where the ad views/clicks occur (for example, \"US\" or \"FR\"). This is a geography dimension.",
"Format of the ad unit (for example, \"banner\", \"native\"), an ad delivery dimension.",
"Mobile OS platform of the app (for example, \"Android\" or \"iOS\")."
"Mobile OS platform of the app (for example, \"Android\" or \"iOS\").",
"Mobile operating system version, e.g. \"iOS 13.5.1\". **Warning:** The dimension is incompatible with [ESTIMATED_EARNINGS](#Metric.ENUM_VALUES.ESTIMATED_EARNINGS), [OBSERVED_ECPM](#Metric.ENUM_VALUES.OBSERVED_ECPM) metrics.",
"GMA SDK version, e.g. \"iOS 7.62.0\". **Warning:** The dimension is incompatible with [ESTIMATED_EARNINGS](#Metric.ENUM_VALUES.ESTIMATED_EARNINGS), [OBSERVED_ECPM](#Metric.ENUM_VALUES.OBSERVED_ECPM) metrics.",
"For Android, the app version name can be found in versionName in PackageInfo. For iOS, the app version name can be found in CFBundleShortVersionString. **Warning:** The dimension is incompatible with [ESTIMATED_EARNINGS](#Metric.ENUM_VALUES.ESTIMATED_EARNINGS), [OBSERVED_ECPM](#Metric.ENUM_VALUES.OBSERVED_ECPM) metrics.",
"Restriction mode for ads serving (e.g. \"Non-personalized ads\"). **Warning:** The dimension is incompatible with [ESTIMATED_EARNINGS](#Metric.ENUM_VALUES.ESTIMATED_EARNINGS) metric."
],
"type": "string"
},
@@ -597,7 +827,7 @@
"type": "object"
},
"NetworkReportSpec": {
"description": "The specification for generating an AdMob Network report. For example, the specification to get clicks and estimated earnings for only the 'US' and 'CN' countries can look like the following example: { 'date_range': { 'start_date': {'year': 2018, 'month': 9, 'day': 1}, 'end_date': {'year': 2018, 'month': 9, 'day': 30} }, 'dimensions': ['DATE', 'APP', 'COUNTRY'], 'metrics': ['CLICKS', 'ESTIMATED_EARNINGS'], 'dimension_filters': [ { 'dimension': 'COUNTRY', 'matches_any': {'values': [{'value': 'US', 'value': 'CN'}]} } ], 'sort_conditions': [ {'dimension':'APP', order: 'ASCENDING'}, {'metric':'CLICKS', order: 'DESCENDING'} ], 'localization_settings': { 'currency_code': 'USD', 'language_code': 'en-US' } } For a better understanding, you can treat the preceding specification like the following pseudo SQL: SELECT DATE, APP, COUNTRY, CLICKS, ESTIMATED_EARNINGS FROM NETWORK_REPORT WHERE DATE >= '2018-09-01' AND DATE <= '2018-09-30' AND COUNTRY IN ('US', 'CN') GROUP BY DATE, APP, COUNTRY ORDER BY APP ASC, CLICKS DESC;",
"description": "The specification for generating an AdMob Network report. For example, the specification to get clicks and estimated earnings for only the 'US' and 'CN' countries can look like the following example: { 'date_range': { 'start_date': {'year': 2021, 'month': 9, 'day': 1}, 'end_date': {'year': 2021, 'month': 9, 'day': 30} }, 'dimensions': ['DATE', 'APP', 'COUNTRY'], 'metrics': ['CLICKS', 'ESTIMATED_EARNINGS'], 'dimension_filters': [ { 'dimension': 'COUNTRY', 'matches_any': {'values': [{'value': 'US', 'value': 'CN'}]} } ], 'sort_conditions': [ {'dimension':'APP', order: 'ASCENDING'}, {'metric':'CLICKS', order: 'DESCENDING'} ], 'localization_settings': { 'currency_code': 'USD', 'language_code': 'en-US' } } For a better understanding, you can treat the preceding specification like the following pseudo SQL: SELECT DATE, APP, COUNTRY, CLICKS, ESTIMATED_EARNINGS FROM NETWORK_REPORT WHERE DATE >= '2021-09-01' AND DATE <= '2021-09-30' AND COUNTRY IN ('US', 'CN') GROUP BY DATE, APP, COUNTRY ORDER BY APP ASC, CLICKS DESC;",
"id": "NetworkReportSpec",
"properties": {
"dateRange": {
@@ -624,19 +854,27 @@
"AD_TYPE",
"COUNTRY",
"FORMAT",
"PLATFORM"
"PLATFORM",
"MOBILE_OS_VERSION",
"GMA_SDK_VERSION",
"APP_VERSION_NAME",
"SERVING_RESTRICTION"
],
"enumDescriptions": [
"Default value for an unset field. Do not use.",
"A date in the YYYY-MM-DD format (for example, \"2018-12-21\"). Requests can specify at most one time dimension.",
"A month in the YYYY-MM format (for example, \"2018-12\"). Requests can specify at most one time dimension.",
"The date of the first day of a week in the YYYY-MM-DD format (for example, \"2018-12-21\"). Requests can specify at most one time dimension.",
"A date in the YYYYMMDD format (for example, \"20210701\"). Requests can specify at most one time dimension.",
"A month in the YYYYMM format (for example, \"202107\"). Requests can specify at most one time dimension.",
"The date of the first day of a week in the YYYYMMDD format (for example, \"20210701\"). Requests can specify at most one time dimension.",
"The unique ID of the ad unit (for example, \"ca-app-pub-1234/1234\"). If AD_UNIT dimension is specified, then APP is included automatically.",
"The unique ID of the mobile application (for example, \"ca-app-pub-1234~1234\").",
"Type of the ad (for example, \"text\" or \"image\"), an ad delivery dimension. **Warning:** The dimension is incompatible with [AD_REQUESTS](#Metric.ENUM_VALUES.AD_REQUESTS), [MATCH_RATE](#Metric.ENUM_VALUES.MATCH_RATE) and [IMPRESSION_RPM](#Metric.ENUM_VALUES.IMPRESSION_RPM) metrics.",
"CLDR country code of the place where the ad views/clicks occur (for example, \"US\" or \"FR\"). This is a geography dimension.",
"Format of the ad unit (for example, \"banner\", \"native\"), an ad delivery dimension.",
"Mobile OS platform of the app (for example, \"Android\" or \"iOS\")."
"Mobile OS platform of the app (for example, \"Android\" or \"iOS\").",
"Mobile operating system version, e.g. \"iOS 13.5.1\".",
"GMA SDK version, e.g. \"iOS 7.62.0\".",
"For Android, the app version name can be found in versionName in PackageInfo. For iOS, the app version name can be found in CFBundleShortVersionString.",
"Restriction mode for ads serving (e.g. \"Non-personalized ads\")."
],
"type": "string"
},
@@ -712,19 +950,27 @@
"AD_TYPE",
"COUNTRY",
"FORMAT",
"PLATFORM"
"PLATFORM",
"MOBILE_OS_VERSION",
"GMA_SDK_VERSION",
"APP_VERSION_NAME",
"SERVING_RESTRICTION"
],
"enumDescriptions": [
"Default value for an unset field. Do not use.",
"A date in the YYYY-MM-DD format (for example, \"2018-12-21\"). Requests can specify at most one time dimension.",
"A month in the YYYY-MM format (for example, \"2018-12\"). Requests can specify at most one time dimension.",
"The date of the first day of a week in the YYYY-MM-DD format (for example, \"2018-12-21\"). Requests can specify at most one time dimension.",
"A date in the YYYYMMDD format (for example, \"20210701\"). Requests can specify at most one time dimension.",
"A month in the YYYYMM format (for example, \"202107\"). Requests can specify at most one time dimension.",
"The date of the first day of a week in the YYYYMMDD format (for example, \"20210701\"). Requests can specify at most one time dimension.",
"The unique ID of the ad unit (for example, \"ca-app-pub-1234/1234\"). If AD_UNIT dimension is specified, then APP is included automatically.",
"The unique ID of the mobile application (for example, \"ca-app-pub-1234~1234\").",
"Type of the ad (for example, \"text\" or \"image\"), an ad delivery dimension. **Warning:** The dimension is incompatible with [AD_REQUESTS](#Metric.ENUM_VALUES.AD_REQUESTS), [MATCH_RATE](#Metric.ENUM_VALUES.MATCH_RATE) and [IMPRESSION_RPM](#Metric.ENUM_VALUES.IMPRESSION_RPM) metrics.",
"CLDR country code of the place where the ad views/clicks occur (for example, \"US\" or \"FR\"). This is a geography dimension.",
"Format of the ad unit (for example, \"banner\", \"native\"), an ad delivery dimension.",
"Mobile OS platform of the app (for example, \"Android\" or \"iOS\")."
"Mobile OS platform of the app (for example, \"Android\" or \"iOS\").",
"Mobile operating system version, e.g. \"iOS 13.5.1\".",
"GMA SDK version, e.g. \"iOS 7.62.0\".",
"For Android, the app version name can be found in versionName in PackageInfo. For iOS, the app version name can be found in CFBundleShortVersionString.",
"Restriction mode for ads serving (e.g. \"Non-personalized ads\")."
],
"type": "string"
},
@@ -751,19 +997,27 @@
"AD_TYPE",
"COUNTRY",
"FORMAT",
"PLATFORM"
"PLATFORM",
"MOBILE_OS_VERSION",
"GMA_SDK_VERSION",
"APP_VERSION_NAME",
"SERVING_RESTRICTION"
],
"enumDescriptions": [
"Default value for an unset field. Do not use.",
"A date in the YYYY-MM-DD format (for example, \"2018-12-21\"). Requests can specify at most one time dimension.",
"A month in the YYYY-MM format (for example, \"2018-12\"). Requests can specify at most one time dimension.",
"The date of the first day of a week in the YYYY-MM-DD format (for example, \"2018-12-21\"). Requests can specify at most one time dimension.",
"A date in the YYYYMMDD format (for example, \"20210701\"). Requests can specify at most one time dimension.",
"A month in the YYYYMM format (for example, \"202107\"). Requests can specify at most one time dimension.",
"The date of the first day of a week in the YYYYMMDD format (for example, \"20210701\"). Requests can specify at most one time dimension.",
"The unique ID of the ad unit (for example, \"ca-app-pub-1234/1234\"). If AD_UNIT dimension is specified, then APP is included automatically.",
"The unique ID of the mobile application (for example, \"ca-app-pub-1234~1234\").",
"Type of the ad (for example, \"text\" or \"image\"), an ad delivery dimension. **Warning:** The dimension is incompatible with [AD_REQUESTS](#Metric.ENUM_VALUES.AD_REQUESTS), [MATCH_RATE](#Metric.ENUM_VALUES.MATCH_RATE) and [IMPRESSION_RPM](#Metric.ENUM_VALUES.IMPRESSION_RPM) metrics.",
"CLDR country code of the place where the ad views/clicks occur (for example, \"US\" or \"FR\"). This is a geography dimension.",
"Format of the ad unit (for example, \"banner\", \"native\"), an ad delivery dimension.",
"Mobile OS platform of the app (for example, \"Android\" or \"iOS\")."
"Mobile OS platform of the app (for example, \"Android\" or \"iOS\").",
"Mobile operating system version, e.g. \"iOS 13.5.1\".",
"GMA SDK version, e.g. \"iOS 7.62.0\".",
"For Android, the app version name can be found in versionName in PackageInfo. For iOS, the app version name can be found in CFBundleShortVersionString.",
"Restriction mode for ads serving (e.g. \"Non-personalized ads\")."
],
"type": "string"
},

122
etc/api/admob/v1beta/admob-api.json
View File

@@ -321,7 +321,7 @@
}
}
},
"revision": "20210331",
"revision": "20220303",
"rootUrl": "https://admob.googleapis.com/",
"schemas": {
"AdUnit": {
@@ -413,7 +413,7 @@
"type": "object"
},
"Date": {
"description": "Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.",
"description": "Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp",
"id": "Date",
"properties": {
"day": {
@@ -579,7 +579,7 @@
"type": "object"
},
"MediationReportSpec": {
"description": "The specification for generating an AdMob Mediation report. For example, the specification to get observed ECPM sliced by ad source and app for the 'US' and 'CN' countries can look like the following example: { \"date_range\": { \"start_date\": {\"year\": 2018, \"month\": 9, \"day\": 1}, \"end_date\": {\"year\": 2018, \"month\": 9, \"day\": 30} }, \"dimensions\": [\"AD_SOURCE\", \"APP\", \"COUNTRY\"], \"metrics\": [\"OBSERVED_ECPM\"], \"dimension_filters\": [ { \"dimension\": \"COUNTRY\", \"matches_any\": {\"values\": [{\"value\": \"US\", \"value\": \"CN\"}]} } ], \"sort_conditions\": [ {\"dimension\":\"APP\", order: \"ASCENDING\"} ], \"localization_settings\": { \"currency_code\": \"USD\", \"language_code\": \"en-US\" } } For a better understanding, you can treat the preceding specification like the following pseudo SQL: SELECT AD_SOURCE, APP, COUNTRY, OBSERVED_ECPM FROM MEDIATION_REPORT WHERE DATE >= '2018-09-01' AND DATE <= '2018-09-30' AND COUNTRY IN ('US', 'CN') GROUP BY AD_SOURCE, APP, COUNTRY ORDER BY APP ASC;",
"description": "The specification for generating an AdMob Mediation report. For example, the specification to get observed ECPM sliced by ad source and app for the 'US' and 'CN' countries can look like the following example: { \"date_range\": { \"start_date\": {\"year\": 2021, \"month\": 9, \"day\": 1}, \"end_date\": {\"year\": 2021, \"month\": 9, \"day\": 30} }, \"dimensions\": [\"AD_SOURCE\", \"APP\", \"COUNTRY\"], \"metrics\": [\"OBSERVED_ECPM\"], \"dimension_filters\": [ { \"dimension\": \"COUNTRY\", \"matches_any\": {\"values\": [{\"value\": \"US\", \"value\": \"CN\"}]} } ], \"sort_conditions\": [ {\"dimension\":\"APP\", order: \"ASCENDING\"} ], \"localization_settings\": { \"currency_code\": \"USD\", \"language_code\": \"en-US\" } } For a better understanding, you can treat the preceding specification like the following pseudo SQL: SELECT AD_SOURCE, APP, COUNTRY, OBSERVED_ECPM FROM MEDIATION_REPORT WHERE DATE >= '2021-09-01' AND DATE <= '2021-09-30' AND COUNTRY IN ('US', 'CN') GROUP BY AD_SOURCE, APP, COUNTRY ORDER BY APP ASC;",
"id": "MediationReportSpec",
"properties": {
"dateRange": {
@@ -608,21 +608,29 @@
"MEDIATION_GROUP",
"COUNTRY",
"FORMAT",
"PLATFORM"
"PLATFORM",
"MOBILE_OS_VERSION",
"GMA_SDK_VERSION",
"APP_VERSION_NAME",
"SERVING_RESTRICTION"
],
"enumDescriptions": [
"Default value for an unset field. Do not use.",
"A date in the YYYY-MM-DD format (for example, \"2018-12-21\"). Requests can specify at most one time dimension.",
"A month in the YYYY-MM format (for example, \"2018-12\"). Requests can specify at most one time dimension.",
"The date of the first day of a week in the YYYY-MM-DD format (for example, \"2018-12-21\"). Requests can specify at most one time dimension.",
"A date in the YYYYMMDD format (for example, \"20210701\"). Requests can specify at most one time dimension.",
"A month in the YYYYMM format (for example, \"202107\"). Requests can specify at most one time dimension.",
"The date of the first day of a week in the YYYYMMDD format (for example, \"20210701\"). Requests can specify at most one time dimension.",
"The [unique ID of the ad source](/admob/api/v1/ad_sources) (for example, \"5450213213286189855\" and \"AdMob Network\" as label value).",
"The unique ID of the ad source instance (for example, \"ca-app-pub-1234#5678\" and \"AdMob (default)\" as label value).",
"The unique ID of the ad source instance (for example, \"ca-app-pub-1234:asi:5678\" and \"AdMob (default)\" as label value).",
"The unique ID of the ad unit (for example, \"ca-app-pub-1234/8790\"). If AD_UNIT dimension is specified, then APP is included automatically.",
"The unique ID of the mobile application (for example, \"ca-app-pub-1234~1234\").",
"The unique ID of the mediation group (for example, \"ca-app-pub-1234:mg:1234\" and \"AdMob (default)\" as label value).",
"CLDR country code of the place where the ad views/clicks occur (for example, \"US\" or \"FR\"). This is a geography dimension.",
"Format of the ad unit (for example, \"banner\", \"native\"), an ad delivery dimension.",
"Mobile OS platform of the app (for example, \"Android\" or \"iOS\")."
"Mobile OS platform of the app (for example, \"Android\" or \"iOS\").",
"Mobile operating system version, e.g. \"iOS 13.5.1\". **Warning:** The dimension is incompatible with [ESTIMATED_EARNINGS](#Metric.ENUM_VALUES.ESTIMATED_EARNINGS), [OBSERVED_ECPM](#Metric.ENUM_VALUES.OBSERVED_ECPM) metrics.",
"GMA SDK version, e.g. \"iOS 7.62.0\". **Warning:** The dimension is incompatible with [ESTIMATED_EARNINGS](#Metric.ENUM_VALUES.ESTIMATED_EARNINGS), [OBSERVED_ECPM](#Metric.ENUM_VALUES.OBSERVED_ECPM) metrics.",
"For Android, the app version name can be found in versionName in PackageInfo. For iOS, the app version name can be found in CFBundleShortVersionString. **Warning:** The dimension is incompatible with [ESTIMATED_EARNINGS](#Metric.ENUM_VALUES.ESTIMATED_EARNINGS), [OBSERVED_ECPM](#Metric.ENUM_VALUES.OBSERVED_ECPM) metrics.",
"Restriction mode for ads serving (e.g. \"Non-personalized ads\"). **Warning:** The dimension is incompatible with [ESTIMATED_EARNINGS](#Metric.ENUM_VALUES.ESTIMATED_EARNINGS) metric."
],
"type": "string"
},
@@ -698,21 +706,29 @@
"MEDIATION_GROUP",
"COUNTRY",
"FORMAT",
"PLATFORM"
"PLATFORM",
"MOBILE_OS_VERSION",
"GMA_SDK_VERSION",
"APP_VERSION_NAME",
"SERVING_RESTRICTION"
],
"enumDescriptions": [
"Default value for an unset field. Do not use.",
"A date in the YYYY-MM-DD format (for example, \"2018-12-21\"). Requests can specify at most one time dimension.",
"A month in the YYYY-MM format (for example, \"2018-12\"). Requests can specify at most one time dimension.",
"The date of the first day of a week in the YYYY-MM-DD format (for example, \"2018-12-21\"). Requests can specify at most one time dimension.",
"A date in the YYYYMMDD format (for example, \"20210701\"). Requests can specify at most one time dimension.",
"A month in the YYYYMM format (for example, \"202107\"). Requests can specify at most one time dimension.",
"The date of the first day of a week in the YYYYMMDD format (for example, \"20210701\"). Requests can specify at most one time dimension.",
"The [unique ID of the ad source](/admob/api/v1/ad_sources) (for example, \"5450213213286189855\" and \"AdMob Network\" as label value).",
"The unique ID of the ad source instance (for example, \"ca-app-pub-1234#5678\" and \"AdMob (default)\" as label value).",
"The unique ID of the ad source instance (for example, \"ca-app-pub-1234:asi:5678\" and \"AdMob (default)\" as label value).",
"The unique ID of the ad unit (for example, \"ca-app-pub-1234/8790\"). If AD_UNIT dimension is specified, then APP is included automatically.",
"The unique ID of the mobile application (for example, \"ca-app-pub-1234~1234\").",
"The unique ID of the mediation group (for example, \"ca-app-pub-1234:mg:1234\" and \"AdMob (default)\" as label value).",
"CLDR country code of the place where the ad views/clicks occur (for example, \"US\" or \"FR\"). This is a geography dimension.",
"Format of the ad unit (for example, \"banner\", \"native\"), an ad delivery dimension.",
"Mobile OS platform of the app (for example, \"Android\" or \"iOS\")."
"Mobile OS platform of the app (for example, \"Android\" or \"iOS\").",
"Mobile operating system version, e.g. \"iOS 13.5.1\". **Warning:** The dimension is incompatible with [ESTIMATED_EARNINGS](#Metric.ENUM_VALUES.ESTIMATED_EARNINGS), [OBSERVED_ECPM](#Metric.ENUM_VALUES.OBSERVED_ECPM) metrics.",
"GMA SDK version, e.g. \"iOS 7.62.0\". **Warning:** The dimension is incompatible with [ESTIMATED_EARNINGS](#Metric.ENUM_VALUES.ESTIMATED_EARNINGS), [OBSERVED_ECPM](#Metric.ENUM_VALUES.OBSERVED_ECPM) metrics.",
"For Android, the app version name can be found in versionName in PackageInfo. For iOS, the app version name can be found in CFBundleShortVersionString. **Warning:** The dimension is incompatible with [ESTIMATED_EARNINGS](#Metric.ENUM_VALUES.ESTIMATED_EARNINGS), [OBSERVED_ECPM](#Metric.ENUM_VALUES.OBSERVED_ECPM) metrics.",
"Restriction mode for ads serving (e.g. \"Non-personalized ads\"). **Warning:** The dimension is incompatible with [ESTIMATED_EARNINGS](#Metric.ENUM_VALUES.ESTIMATED_EARNINGS) metric."
],
"type": "string"
},
@@ -741,21 +757,29 @@
"MEDIATION_GROUP",
"COUNTRY",
"FORMAT",
"PLATFORM"
"PLATFORM",
"MOBILE_OS_VERSION",
"GMA_SDK_VERSION",
"APP_VERSION_NAME",
"SERVING_RESTRICTION"
],
"enumDescriptions": [
"Default value for an unset field. Do not use.",
"A date in the YYYY-MM-DD format (for example, \"2018-12-21\"). Requests can specify at most one time dimension.",
"A month in the YYYY-MM format (for example, \"2018-12\"). Requests can specify at most one time dimension.",
"The date of the first day of a week in the YYYY-MM-DD format (for example, \"2018-12-21\"). Requests can specify at most one time dimension.",
"A date in the YYYYMMDD format (for example, \"20210701\"). Requests can specify at most one time dimension.",
"A month in the YYYYMM format (for example, \"202107\"). Requests can specify at most one time dimension.",
"The date of the first day of a week in the YYYYMMDD format (for example, \"20210701\"). Requests can specify at most one time dimension.",
"The [unique ID of the ad source](/admob/api/v1/ad_sources) (for example, \"5450213213286189855\" and \"AdMob Network\" as label value).",
"The unique ID of the ad source instance (for example, \"ca-app-pub-1234#5678\" and \"AdMob (default)\" as label value).",
"The unique ID of the ad source instance (for example, \"ca-app-pub-1234:asi:5678\" and \"AdMob (default)\" as label value).",
"The unique ID of the ad unit (for example, \"ca-app-pub-1234/8790\"). If AD_UNIT dimension is specified, then APP is included automatically.",
"The unique ID of the mobile application (for example, \"ca-app-pub-1234~1234\").",
"The unique ID of the mediation group (for example, \"ca-app-pub-1234:mg:1234\" and \"AdMob (default)\" as label value).",
"CLDR country code of the place where the ad views/clicks occur (for example, \"US\" or \"FR\"). This is a geography dimension.",
"Format of the ad unit (for example, \"banner\", \"native\"), an ad delivery dimension.",
"Mobile OS platform of the app (for example, \"Android\" or \"iOS\")."
"Mobile OS platform of the app (for example, \"Android\" or \"iOS\").",
"Mobile operating system version, e.g. \"iOS 13.5.1\". **Warning:** The dimension is incompatible with [ESTIMATED_EARNINGS](#Metric.ENUM_VALUES.ESTIMATED_EARNINGS), [OBSERVED_ECPM](#Metric.ENUM_VALUES.OBSERVED_ECPM) metrics.",
"GMA SDK version, e.g. \"iOS 7.62.0\". **Warning:** The dimension is incompatible with [ESTIMATED_EARNINGS](#Metric.ENUM_VALUES.ESTIMATED_EARNINGS), [OBSERVED_ECPM](#Metric.ENUM_VALUES.OBSERVED_ECPM) metrics.",
"For Android, the app version name can be found in versionName in PackageInfo. For iOS, the app version name can be found in CFBundleShortVersionString. **Warning:** The dimension is incompatible with [ESTIMATED_EARNINGS](#Metric.ENUM_VALUES.ESTIMATED_EARNINGS), [OBSERVED_ECPM](#Metric.ENUM_VALUES.OBSERVED_ECPM) metrics.",
"Restriction mode for ads serving (e.g. \"Non-personalized ads\"). **Warning:** The dimension is incompatible with [ESTIMATED_EARNINGS](#Metric.ENUM_VALUES.ESTIMATED_EARNINGS) metric."
],
"type": "string"
},
@@ -803,7 +827,7 @@
"type": "object"
},
"NetworkReportSpec": {
"description": "The specification for generating an AdMob Network report. For example, the specification to get clicks and estimated earnings for only the 'US' and 'CN' countries can look like the following example: { 'date_range': { 'start_date': {'year': 2018, 'month': 9, 'day': 1}, 'end_date': {'year': 2018, 'month': 9, 'day': 30} }, 'dimensions': ['DATE', 'APP', 'COUNTRY'], 'metrics': ['CLICKS', 'ESTIMATED_EARNINGS'], 'dimension_filters': [ { 'dimension': 'COUNTRY', 'matches_any': {'values': [{'value': 'US', 'value': 'CN'}]} } ], 'sort_conditions': [ {'dimension':'APP', order: 'ASCENDING'}, {'metric':'CLICKS', order: 'DESCENDING'} ], 'localization_settings': { 'currency_code': 'USD', 'language_code': 'en-US' } } For a better understanding, you can treat the preceding specification like the following pseudo SQL: SELECT DATE, APP, COUNTRY, CLICKS, ESTIMATED_EARNINGS FROM NETWORK_REPORT WHERE DATE >= '2018-09-01' AND DATE <= '2018-09-30' AND COUNTRY IN ('US', 'CN') GROUP BY DATE, APP, COUNTRY ORDER BY APP ASC, CLICKS DESC;",
"description": "The specification for generating an AdMob Network report. For example, the specification to get clicks and estimated earnings for only the 'US' and 'CN' countries can look like the following example: { 'date_range': { 'start_date': {'year': 2021, 'month': 9, 'day': 1}, 'end_date': {'year': 2021, 'month': 9, 'day': 30} }, 'dimensions': ['DATE', 'APP', 'COUNTRY'], 'metrics': ['CLICKS', 'ESTIMATED_EARNINGS'], 'dimension_filters': [ { 'dimension': 'COUNTRY', 'matches_any': {'values': [{'value': 'US', 'value': 'CN'}]} } ], 'sort_conditions': [ {'dimension':'APP', order: 'ASCENDING'}, {'metric':'CLICKS', order: 'DESCENDING'} ], 'localization_settings': { 'currency_code': 'USD', 'language_code': 'en-US' } } For a better understanding, you can treat the preceding specification like the following pseudo SQL: SELECT DATE, APP, COUNTRY, CLICKS, ESTIMATED_EARNINGS FROM NETWORK_REPORT WHERE DATE >= '2021-09-01' AND DATE <= '2021-09-30' AND COUNTRY IN ('US', 'CN') GROUP BY DATE, APP, COUNTRY ORDER BY APP ASC, CLICKS DESC;",
"id": "NetworkReportSpec",
"properties": {
"dateRange": {
@@ -830,19 +854,27 @@
"AD_TYPE",
"COUNTRY",
"FORMAT",
"PLATFORM"
"PLATFORM",
"MOBILE_OS_VERSION",
"GMA_SDK_VERSION",
"APP_VERSION_NAME",
"SERVING_RESTRICTION"
],
"enumDescriptions": [
"Default value for an unset field. Do not use.",
"A date in the YYYY-MM-DD format (for example, \"2018-12-21\"). Requests can specify at most one time dimension.",
"A month in the YYYY-MM format (for example, \"2018-12\"). Requests can specify at most one time dimension.",
"The date of the first day of a week in the YYYY-MM-DD format (for example, \"2018-12-21\"). Requests can specify at most one time dimension.",
"A date in the YYYYMMDD format (for example, \"20210701\"). Requests can specify at most one time dimension.",
"A month in the YYYYMM format (for example, \"202107\"). Requests can specify at most one time dimension.",
"The date of the first day of a week in the YYYYMMDD format (for example, \"20210701\"). Requests can specify at most one time dimension.",
"The unique ID of the ad unit (for example, \"ca-app-pub-1234/1234\"). If AD_UNIT dimension is specified, then APP is included automatically.",
"The unique ID of the mobile application (for example, \"ca-app-pub-1234~1234\").",
"Type of the ad (for example, \"text\" or \"image\"), an ad delivery dimension. **Warning:** The dimension is incompatible with [AD_REQUESTS](#Metric.ENUM_VALUES.AD_REQUESTS), [MATCH_RATE](#Metric.ENUM_VALUES.MATCH_RATE) and [IMPRESSION_RPM](#Metric.ENUM_VALUES.IMPRESSION_RPM) metrics.",
"CLDR country code of the place where the ad views/clicks occur (for example, \"US\" or \"FR\"). This is a geography dimension.",
"Format of the ad unit (for example, \"banner\", \"native\"), an ad delivery dimension.",
"Mobile OS platform of the app (for example, \"Android\" or \"iOS\")."
"Mobile OS platform of the app (for example, \"Android\" or \"iOS\").",
"Mobile operating system version, e.g. \"iOS 13.5.1\".",
"GMA SDK version, e.g. \"iOS 7.62.0\".",
"For Android, the app version name can be found in versionName in PackageInfo. For iOS, the app version name can be found in CFBundleShortVersionString.",
"Restriction mode for ads serving (e.g. \"Non-personalized ads\")."
],
"type": "string"
},
@@ -918,19 +950,27 @@
"AD_TYPE",
"COUNTRY",
"FORMAT",
"PLATFORM"
"PLATFORM",
"MOBILE_OS_VERSION",
"GMA_SDK_VERSION",
"APP_VERSION_NAME",
"SERVING_RESTRICTION"
],
"enumDescriptions": [
"Default value for an unset field. Do not use.",
"A date in the YYYY-MM-DD format (for example, \"2018-12-21\"). Requests can specify at most one time dimension.",
"A month in the YYYY-MM format (for example, \"2018-12\"). Requests can specify at most one time dimension.",
"The date of the first day of a week in the YYYY-MM-DD format (for example, \"2018-12-21\"). Requests can specify at most one time dimension.",
"A date in the YYYYMMDD format (for example, \"20210701\"). Requests can specify at most one time dimension.",
"A month in the YYYYMM format (for example, \"202107\"). Requests can specify at most one time dimension.",
"The date of the first day of a week in the YYYYMMDD format (for example, \"20210701\"). Requests can specify at most one time dimension.",
"The unique ID of the ad unit (for example, \"ca-app-pub-1234/1234\"). If AD_UNIT dimension is specified, then APP is included automatically.",
"The unique ID of the mobile application (for example, \"ca-app-pub-1234~1234\").",
"Type of the ad (for example, \"text\" or \"image\"), an ad delivery dimension. **Warning:** The dimension is incompatible with [AD_REQUESTS](#Metric.ENUM_VALUES.AD_REQUESTS), [MATCH_RATE](#Metric.ENUM_VALUES.MATCH_RATE) and [IMPRESSION_RPM](#Metric.ENUM_VALUES.IMPRESSION_RPM) metrics.",
"CLDR country code of the place where the ad views/clicks occur (for example, \"US\" or \"FR\"). This is a geography dimension.",
"Format of the ad unit (for example, \"banner\", \"native\"), an ad delivery dimension.",
"Mobile OS platform of the app (for example, \"Android\" or \"iOS\")."
"Mobile OS platform of the app (for example, \"Android\" or \"iOS\").",
"Mobile operating system version, e.g. \"iOS 13.5.1\".",
"GMA SDK version, e.g. \"iOS 7.62.0\".",
"For Android, the app version name can be found in versionName in PackageInfo. For iOS, the app version name can be found in CFBundleShortVersionString.",
"Restriction mode for ads serving (e.g. \"Non-personalized ads\")."
],
"type": "string"
},
@@ -957,19 +997,27 @@
"AD_TYPE",
"COUNTRY",
"FORMAT",
"PLATFORM"
"PLATFORM",
"MOBILE_OS_VERSION",
"GMA_SDK_VERSION",
"APP_VERSION_NAME",
"SERVING_RESTRICTION"
],
"enumDescriptions": [
"Default value for an unset field. Do not use.",
"A date in the YYYY-MM-DD format (for example, \"2018-12-21\"). Requests can specify at most one time dimension.",
"A month in the YYYY-MM format (for example, \"2018-12\"). Requests can specify at most one time dimension.",
"The date of the first day of a week in the YYYY-MM-DD format (for example, \"2018-12-21\"). Requests can specify at most one time dimension.",
"A date in the YYYYMMDD format (for example, \"20210701\"). Requests can specify at most one time dimension.",
"A month in the YYYYMM format (for example, \"202107\"). Requests can specify at most one time dimension.",
"The date of the first day of a week in the YYYYMMDD format (for example, \"20210701\"). Requests can specify at most one time dimension.",
"The unique ID of the ad unit (for example, \"ca-app-pub-1234/1234\"). If AD_UNIT dimension is specified, then APP is included automatically.",
"The unique ID of the mobile application (for example, \"ca-app-pub-1234~1234\").",
"Type of the ad (for example, \"text\" or \"image\"), an ad delivery dimension. **Warning:** The dimension is incompatible with [AD_REQUESTS](#Metric.ENUM_VALUES.AD_REQUESTS), [MATCH_RATE](#Metric.ENUM_VALUES.MATCH_RATE) and [IMPRESSION_RPM](#Metric.ENUM_VALUES.IMPRESSION_RPM) metrics.",
"CLDR country code of the place where the ad views/clicks occur (for example, \"US\" or \"FR\"). This is a geography dimension.",
"Format of the ad unit (for example, \"banner\", \"native\"), an ad delivery dimension.",
"Mobile OS platform of the app (for example, \"Android\" or \"iOS\")."
"Mobile OS platform of the app (for example, \"Android\" or \"iOS\").",
"Mobile operating system version, e.g. \"iOS 13.5.1\".",
"GMA SDK version, e.g. \"iOS 7.62.0\".",
"For Android, the app version name can be found in versionName in PackageInfo. For iOS, the app version name can be found in CFBundleShortVersionString.",
"Restriction mode for ads serving (e.g. \"Non-personalized ads\")."
],
"type": "string"
},

2281
etc/api/adsense/v2/adsense-api.json Normal file
View File

File diff suppressed because it is too large Load Diff

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

@@ -243,7 +243,7 @@
"type": "string"
},
"filter": {
"description": "Optional. A query string for filtering alert results. For more details, see [Query filters](/admin-sdk/alertcenter/guides/query-filters) and [Supported query filter fields](/admin-sdk/alertcenter/reference/filter-fields#alerts.list).",
"description": "Optional. A query string for filtering alert results. For more details, see [Query filters](https://developers.google.com/admin-sdk/alertcenter/guides/query-filters) and [Supported query filter fields](https://developers.google.com/admin-sdk/alertcenter/reference/filter-fields#alerts.list).",
"location": "query",
"type": "string"
},
@@ -356,7 +356,7 @@
"type": "string"
},
"filter": {
"description": "Optional. A query string for filtering alert feedback results. For more details, see [Query filters](/admin-sdk/alertcenter/guides/query-filters) and [Supported query filter fields](/admin-sdk/alertcenter/reference/filter-fields#alerts.feedback.list).",
"description": "Optional. A query string for filtering alert feedback results. For more details, see [Query filters](https://developers.google.com/admin-sdk/alertcenter/guides/query-filters) and [Supported query filter fields](https://developers.google.com/admin-sdk/alertcenter/reference/filter-fields#alerts.feedback.list).",
"location": "query",
"type": "string"
}
@@ -423,9 +423,83 @@
}
}
},
"revision": "20210323",
"revision": "20220221",
"rootUrl": "https://alertcenter.googleapis.com/",
"schemas": {
"AccountSuspensionDetails": {
"description": "Details about why an account is receiving an account suspension warning.",
"id": "AccountSuspensionDetails",
"properties": {
"abuseReason": {
"description": "The reason why this account is receiving an account suspension warning.",
"enum": [
"ACCOUNT_SUSPENSION_ABUSE_REASON_UNSPECIFIED",
"TOS_VIOLATION",
"SPAM",
"PHISHING",
"TRAFFIC_PUMPING",
"FRAUD",
"NUMBER_HARVESTING",
"PAYMENTS_FRAUD",
"UNWANTED_CONTENT"
],
"enumDescriptions": [
"Abuse reason is unspecified.",
"This account is being suspended for a Terms of Service violation.",
"This account is being suspended for spam.",
"This account is being suspended for phishing.",
"This account is being suspended for artificially boosting traffic to a website.",
"This account is being suspended for fraud.",
"This account is being suspended for number harvesting.",
"This account is being suspended for payments fraud.",
"This account is being suspended for unwanted content."
],
"type": "string"
},
"productName": {
"description": "The name of the product being abused. This is restricted to only the following values: \"Gmail\" \"Google Workspace\" \"Payments\" \"Voice\" \"YouTube\" \"Other\"",
"type": "string"
}
},
"type": "object"
},
"AccountSuspensionWarning": {
"description": "A warning that the customer's account is about to be suspended.",
"id": "AccountSuspensionWarning",
"properties": {
"appealWindow": {
"description": "The amount of time remaining to appeal an imminent suspension. After this window has elapsed, the account will be suspended. Only populated if the account suspension is in WARNING state.",
"format": "google-duration",
"type": "string"
},
"state": {
"description": "Account suspension warning state.",
"enum": [
"ACCOUNT_SUSPENSION_WARNING_STATE_UNSPECIFIED",
"WARNING",
"SUSPENDED",
"APPEAL_APPROVED",
"APPEAL_SUBMITTED"
],
"enumDescriptions": [
"State is unspecified.",
"Customer is receiving a warning about imminent suspension.",
"Customer is being notified that their account has been suspended.",
"Customer is being notified that their suspension appeal was approved.",
"Customer has submitted their appeal, which is pending review."
],
"type": "string"
},
"suspensionDetails": {
"description": "Details about why an account is being suspended.",
"items": {
"$ref": "AccountSuspensionDetails"
},
"type": "array"
}
},
"type": "object"
},
"AccountWarning": {
"description": "Alerts for user account warning events.",
"id": "AccountWarning",
@@ -558,7 +632,7 @@
"type": "string"
},
"source": {
"description": "Required. A unique identifier for the system that reported the alert. This is output only after alert is created. Supported sources are any of the following: * Google Operations * Mobile device management * Gmail phishing * Domain wide takeout * State sponsored attack * Google identity",
"description": "Required. A unique identifier for the system that reported the alert. This is output only after alert is created. Supported sources are any of the following: * Google Operations * Mobile device management * Gmail phishing * Data Loss Prevention * Domain wide takeout * State sponsored attack * Google identity * Apps outage",
"type": "string"
},
"startTime": {
@@ -567,7 +641,7 @@
"type": "string"
},
"type": {
"description": "Required. The type of the alert. This is output only after alert is created. For a list of available alert types see [Google Workspace Alert types](/admin-sdk/alertcenter/reference/alert-types).",
"description": "Required. The type of the alert. This is output only after alert is created. For a list of available alert types see [Google Workspace Alert types](https://developers.google.com/admin-sdk/alertcenter/reference/alert-types).",
"type": "string"
},
"updateTime": {
@@ -639,7 +713,7 @@
"type": "string"
},
"etag": {
"description": "Optional. `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of an alert metadata from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform metatdata updates in order to avoid race conditions: An `etag` is returned in the response which contains alert metadata, and systems are expected to put that etag in the request to update alert metadata to ensure that their change will be applied to the same version of the alert metadata. If no `etag` is provided in the call to update alert metadata, then the existing alert metadata is overwritten blindly.",
"description": "Optional. `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of an alert metadata from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform metadata updates in order to avoid race conditions: An `etag` is returned in the response which contains alert metadata, and systems are expected to put that etag in the request to update alert metadata to ensure that their change will be applied to the same version of the alert metadata. If no `etag` is provided in the call to update alert metadata, then the existing alert metadata is overwritten blindly.",
"type": "string"
},
"severity": {
@@ -672,6 +746,82 @@
},
"type": "object"
},
"AppSettingsChanged": {
"description": "Alerts from AppSettingsChanged bucket Rules configured by Admin which contain the below rules. Calendar settings changed Drive settings changed Email settings changed Mobile settings changed",
"id": "AppSettingsChanged",
"properties": {
"alertDetails": {
"description": "Any other associated alert details, for example, AlertConfiguration.",
"format": "byte",
"type": "string"
},
"name": {
"description": "Rule name",
"type": "string"
}
},
"type": "object"
},
"AppsOutage": {
"description": "An outage incident reported for a Google Workspace service.",
"id": "AppsOutage",
"properties": {
"dashboardUri": {
"description": "Link to the outage event in Google Workspace Status Dashboard",
"type": "string"
},
"incidentTrackingId": {
"description": "Incident tracking ID.",
"type": "string"
},
"mergeInfo": {
"$ref": "MergeInfo",
"description": "Indicates new alert details under which the outage is communicated. Only populated when Status is MERGED."
},
"nextUpdateTime": {
"description": "Timestamp by which the next update is expected to arrive.",
"format": "google-datetime",
"type": "string"
},
"products": {
"description": "List of products impacted by the outage.",
"items": {
"type": "string"
},
"type": "array"
},
"resolutionTime": {
"description": "Timestamp when the outage is expected to be resolved, or has confirmed resolution. Provided only when known.",
"format": "google-datetime",
"type": "string"
},
"status": {
"description": "Current outage status.",
"enum": [
"STATUS_UNSPECIFIED",
"NEW",
"ONGOING",
"RESOLVED",
"FALSE_POSITIVE",
"PARTIALLY_RESOLVED",
"MERGED",
"DOWNGRADED"
],
"enumDescriptions": [
"Status is unspecified.",
"The incident has just been reported.",
"The incident is ongoing.",
"The incident has been resolved.",
"Further assessment indicated no customer impact.",
"The incident has been partially resolved.",
"The incident was merged into a parent.",
"The incident has lower impact than initially anticipated."
],
"type": "string"
}
},
"type": "object"
},
"Attachment": {
"description": "Attachment with application-specific information about an alert.",
"id": "Attachment",
@@ -953,7 +1103,7 @@
"type": "array"
},
"date": {
"description": "The date the malicious email was sent.",
"description": "The date of the event related to this email.",
"format": "google-datetime",
"type": "string"
},
@@ -1003,6 +1153,10 @@
"description": "A detailed, freeform incident description.",
"type": "string"
},
"domain": {
"description": "Customer domain for email template personalization.",
"type": "string"
},
"header": {
"description": "A header to display above the incident message. Typically used to attach a localized notice on the timeline for followup comms translations.",
"type": "string"
@@ -1136,8 +1290,23 @@
},
"type": "object"
},
"MergeInfo": {
"description": "New alert tracking numbers.",
"id": "MergeInfo",
"properties": {
"newAlertId": {
"description": "Optional. New alert ID. Reference the [google.apps.alertcenter.Alert] with this ID for the current state.",
"type": "string"
},
"newIncidentTrackingId": {
"description": "The new tracking ID from the parent incident.",
"type": "string"
}
},
"type": "object"
},
"Notification": {
"description": "Settings for callback notifications. For more details see [Google Workspace Alert Notification](/admin-sdk/alertcenter/guides/notifications).",
"description": "Settings for callback notifications. For more details see [Google Workspace Alert Notification](https://developers.google.com/admin-sdk/alertcenter/guides/notifications).",
"id": "Notification",
"properties": {
"cloudPubsubTopic": {
@@ -1184,6 +1353,27 @@
},
"type": "object"
},
"ReportingRule": {
"description": "Alerts from Reporting Rules configured by Admin.",
"id": "ReportingRule",
"properties": {
"alertDetails": {
"description": "Any other associated alert details, for example, AlertConfiguration.",
"format": "byte",
"type": "string"
},
"name": {
"description": "Rule name",
"type": "string"
},
"query": {
"description": "Alert Rule query Sample Query query { condition { filter { expected_application_id: 777491262838 expected_event_name: \"indexable_content_change\" filter_op: IN } } conjunction_operator: OR }",
"format": "byte",
"type": "string"
}
},
"type": "object"
},
"RequestInfo": {
"description": "Requests for one application that needs default SQL setup.",
"id": "RequestInfo",
@@ -1486,6 +1676,17 @@
},
"type": "object"
},
"UserChanges": {
"description": "Alerts from UserChanges bucket Rules for predefined rules which contain the below rules. Suspended user made active New user Added User suspended (by admin) User granted admin privileges User admin privileges revoked User deleted Users password changed",
"id": "UserChanges",
"properties": {
"name": {
"description": "Rule name",
"type": "string"
}
},
"type": "object"
},
"UserDefinedDetectorInfo": {
"description": "Detector defined by administrators.",
"id": "UserDefinedDetectorInfo",

2510
etc/api/analyticsadmin/v1alpha/analyticsadmin-api.json
View File

File diff suppressed because it is too large Load Diff

276
etc/api/analyticsdata/v1beta/analyticsdata-api.json
View File

@@ -168,6 +168,35 @@
"https://www.googleapis.com/auth/analytics.readonly"
]
},
"checkCompatibility": {
"description": "This compatibility method lists dimensions and metrics that can be added to a report request and maintain compatibility. This method fails if the request's dimensions and metrics are incompatible. In Google Analytics, reports fail if they request incompatible dimensions and/or metrics; in that case, you will need to remove dimensions and/or metrics from the incompatible report until the report is compatible. The Realtime and Core reports have different compatibility rules. This method checks compatibility for Core reports.",
"flatPath": "v1beta/properties/{propertiesId}:checkCompatibility",
"httpMethod": "POST",
"id": "analyticsdata.properties.checkCompatibility",
"parameterOrder": [
"property"
],
"parameters": {
"property": {
"description": "A Google Analytics GA4 property identifier whose events are tracked. To learn more, see [where to find your Property ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id). `property` should be the same value as in your `runReport` request. Example: properties/1234 Set the Property ID to 0 for compatibility checking on dimensions and metrics common to all properties. In this special mode, this method will not return custom dimensions and metrics.",
"location": "path",
"pattern": "^properties/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+property}:checkCompatibility",
"request": {
"$ref": "CheckCompatibilityRequest"
},
"response": {
"$ref": "CheckCompatibilityResponse"
},
"scopes": [
"https://www.googleapis.com/auth/analytics",
"https://www.googleapis.com/auth/analytics.readonly"
]
},
"getMetadata": {
"description": "Returns metadata for dimensions and metrics available in reporting methods. Used to explore the dimensions and metrics. In this method, a Google Analytics GA4 Property Identifier is specified in the request, and the metadata response includes Custom dimensions and metrics as well as Universal metadata. For example if a custom metric with parameter name `levels_unlocked` is registered to a property, the Metadata response will contain `customEvent:levels_unlocked`. Universal metadata are dimensions and metrics applicable to any property such as `country` and `totalUsers`.",
"flatPath": "v1beta/properties/{propertiesId}/metadata",
@@ -284,9 +313,37 @@
}
}
},
"revision": "20210329",
"revision": "20220303",
"rootUrl": "https://analyticsdata.googleapis.com/",
"schemas": {
"ActiveMetricRestriction": {
"description": "A metric actively restricted in creating the report.",
"id": "ActiveMetricRestriction",
"properties": {
"metricName": {
"description": "The name of the restricted metric.",
"type": "string"
},
"restrictedMetricTypes": {
"description": "The reason for this metric's restriction.",
"items": {
"enum": [
"RESTRICTED_METRIC_TYPE_UNSPECIFIED",
"COST_DATA",
"REVENUE_DATA"
],
"enumDescriptions": [
"Unspecified type.",
"Cost metrics such as `adCost`.",
"Revenue metrics such as `purchaseRevenue`."
],
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"BatchRunPivotReportsRequest": {
"description": "The batch request containing multiple pivot report requests.",
"id": "BatchRunPivotReportsRequest",
@@ -377,6 +434,70 @@
},
"type": "object"
},
"CheckCompatibilityRequest": {
"description": "The request for compatibility information for a report's dimensions and metrics. Check compatibility provides a preview of the compatibility of a report; fields shared with the `runReport` request should be the same values as in your `runReport` request.",
"id": "CheckCompatibilityRequest",
"properties": {
"compatibilityFilter": {
"description": "Filters the dimensions and metrics in the response to just this compatibility. Commonly used as `\u201dcompatibilityFilter\u201d: \u201cCOMPATIBLE\u201d` to only return compatible dimensions & metrics.",
"enum": [
"COMPATIBILITY_UNSPECIFIED",
"COMPATIBLE",
"INCOMPATIBLE"
],
"enumDescriptions": [
"Unspecified compatibility.",
"The dimension or metric is compatible. This dimension or metric can be successfully added to a report.",
"The dimension or metric is incompatible. This dimension or metric cannot be successfully added to a report."
],
"type": "string"
},
"dimensionFilter": {
"$ref": "FilterExpression",
"description": "The filter clause of dimensions. `dimensionFilter` should be the same value as in your `runReport` request."
},
"dimensions": {
"description": "The dimensions in this report. `dimensions` should be the same value as in your `runReport` request.",
"items": {
"$ref": "Dimension"
},
"type": "array"
},
"metricFilter": {
"$ref": "FilterExpression",
"description": "The filter clause of metrics. `metricFilter` should be the same value as in your `runReport` request"
},
"metrics": {
"description": "The metrics in this report. `metrics` should be the same value as in your `runReport` request.",
"items": {
"$ref": "Metric"
},
"type": "array"
}
},
"type": "object"
},
"CheckCompatibilityResponse": {
"description": "The compatibility response with the compatibility of each dimension & metric.",
"id": "CheckCompatibilityResponse",
"properties": {
"dimensionCompatibilities": {
"description": "The compatibility of each dimension.",
"items": {
"$ref": "DimensionCompatibility"
},
"type": "array"
},
"metricCompatibilities": {
"description": "The compatibility of each metric.",
"items": {
"$ref": "MetricCompatibility"
},
"type": "array"
}
},
"type": "object"
},
"Cohort": {
"description": "Defines a cohort selection criteria. A cohort is a group of users who share a common characteristic. For example, users with the same `firstSessionDate` belong to the same cohort.",
"id": "Cohort",
@@ -500,7 +621,7 @@
"type": "object"
},
"Dimension": {
"description": "Dimensions are attributes of your data. For example, the dimension city indicates the city from which an event originates. Dimension values in report responses are strings; for example, city could be \"Paris\" or \"New York\". Requests are allowed up to 8 dimensions.",
"description": "Dimensions are attributes of your data. For example, the dimension city indicates the city from which an event originates. Dimension values in report responses are strings; for example, the city could be \"Paris\" or \"New York\". Requests are allowed up to 9 dimensions.",
"id": "Dimension",
"properties": {
"dimensionExpression": {
@@ -508,12 +629,37 @@
"description": "One dimension can be the result of an expression of multiple dimensions. For example, dimension \"country, city\": concatenate(country, \", \", city)."
},
"name": {
"description": "The name of the dimension. See the [API Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#dimensions) for the list of dimension names. If `dimensionExpression` is specified, `name` can be any string that you would like within the allowed character set. For example if a `dimensionExpression` concatenates `country` and `city`, you could call that dimension `countryAndCity`. Dimension names that you choose must match the regular expression \"^[a-zA-Z0-9_]$\". Dimensions are referenced by `name` in `dimensionFilter`, `orderBys`, `dimensionExpression`, and `pivots`.",
"description": "The name of the dimension. See the [API Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#dimensions) for the list of dimension names. If `dimensionExpression` is specified, `name` can be any string that you would like within the allowed character set. For example if a `dimensionExpression` concatenates `country` and `city`, you could call that dimension `countryAndCity`. Dimension names that you choose must match the regular expression `^[a-zA-Z0-9_]$`. Dimensions are referenced by `name` in `dimensionFilter`, `orderBys`, `dimensionExpression`, and `pivots`.",
"type": "string"
}
},
"type": "object"
},
"DimensionCompatibility": {
"description": "The compatibility for a single dimension.",
"id": "DimensionCompatibility",
"properties": {
"compatibility": {
"description": "The compatibility of this dimension. If the compatibility is COMPATIBLE, this dimension can be successfully added to the report.",
"enum": [
"COMPATIBILITY_UNSPECIFIED",
"COMPATIBLE",
"INCOMPATIBLE"
],
"enumDescriptions": [
"Unspecified compatibility.",
"The dimension or metric is compatible. This dimension or metric can be successfully added to a report.",
"The dimension or metric is incompatible. This dimension or metric cannot be successfully added to a report."
],
"type": "string"
},
"dimensionMetadata": {
"$ref": "DimensionMetadata",
"description": "The dimension metadata contains the API name for this compatibility information. The dimension metadata also contains other helpful information like the UI name and description."
}
},
"type": "object"
},
"DimensionExpression": {
"description": "Used to express a dimension which is the result of a formula of multiple dimensions. Example usages: 1) lower_case(dimension) 2) concatenate(dimension1, symbol, dimension2).",
"id": "DimensionExpression",
@@ -552,6 +698,10 @@
"description": "This dimension's name. Useable in [Dimension](#Dimension)'s `name`. For example, `eventName`.",
"type": "string"
},
"category": {
"description": "The display name of the category that this dimension belongs to. Similar dimensions and metrics are categorized together.",
"type": "string"
},
"customDefinition": {
"description": "True if the dimension is a custom dimension for this property.",
"type": "boolean"
@@ -649,7 +799,7 @@
},
"filter": {
"$ref": "Filter",
"description": "A primitive filter. All fields in filter in same FilterExpression needs to be either all dimensions or metrics."
"description": "A primitive filter. In the same FilterExpression, all of the filter's field names need to be either all dimensions or all metrics."
},
"notExpression": {
"$ref": "FilterExpression",
@@ -732,12 +882,37 @@
"type": "boolean"
},
"name": {
"description": "The name of the metric. See the [API Metrics](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#metrics) for the list of metric names. If `expression` is specified, `name` can be any string that you would like within the allowed character set. For example if `expression` is `screenPageViews/sessions`, you could call that metric's name = `viewsPerSession`. Metric names that you choose must match the regular expression \"^[a-zA-Z0-9_]$\". Metrics are referenced by `name` in `metricFilter`, `orderBys`, and metric `expression`.",
"description": "The name of the metric. See the [API Metrics](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#metrics) for the list of metric names. If `expression` is specified, `name` can be any string that you would like within the allowed character set. For example if `expression` is `screenPageViews/sessions`, you could call that metric's name = `viewsPerSession`. Metric names that you choose must match the regular expression `^[a-zA-Z0-9_]$`. Metrics are referenced by `name` in `metricFilter`, `orderBys`, and metric `expression`.",
"type": "string"
}
},
"type": "object"
},
"MetricCompatibility": {
"description": "The compatibility for a single metric.",
"id": "MetricCompatibility",
"properties": {
"compatibility": {
"description": "The compatibility of this metric. If the compatibility is COMPATIBLE, this metric can be successfully added to the report.",
"enum": [
"COMPATIBILITY_UNSPECIFIED",
"COMPATIBLE",
"INCOMPATIBLE"
],
"enumDescriptions": [
"Unspecified compatibility.",
"The dimension or metric is compatible. This dimension or metric can be successfully added to a report.",
"The dimension or metric is incompatible. This dimension or metric cannot be successfully added to a report."
],
"type": "string"
},
"metricMetadata": {
"$ref": "MetricMetadata",
"description": "The metric metadata contains the API name for this compatibility information. The metric metadata also contains other helpful information like the UI name and description."
}
},
"type": "object"
},
"MetricHeader": {
"description": "Describes a metric column in the report. Visible metrics requested in a report produce column entries within rows and MetricHeaders. However, metrics used exclusively within filters or expressions do not produce columns in a report; correspondingly, those metrics do not produce headers.",
"id": "MetricHeader",
@@ -791,6 +966,27 @@
"description": "A metric name. Useable in [Metric](#Metric)'s `name`. For example, `eventCount`.",
"type": "string"
},
"blockedReasons": {
"description": "If reasons are specified, your access is blocked to this metric for this property. API requests from you to this property for this metric will succeed; however, the report will contain only zeros for this metric. API requests with metric filters on blocked metrics will fail. If reasons are empty, you have access to this metric. To learn more, see [Access and data-restriction management](https://support.google.com/analytics/answer/10851388).",
"items": {
"enum": [
"BLOCKED_REASON_UNSPECIFIED",
"NO_REVENUE_METRICS",
"NO_COST_METRICS"
],
"enumDescriptions": [
"Will never be specified in API response.",
"If present, your access is blocked to revenue related metrics for this property, and this metric is revenue related.",
"If present, your access is blocked to cost related metrics for this property, and this metric is cost related."
],
"type": "string"
},
"type": "array"
},
"category": {
"description": "The display name of the category that this metrics belongs to. Similar dimensions and metrics are categorized together.",
"type": "string"
},
"customDefinition": {
"description": "True if the metric is a custom metric for this property.",
"type": "boolean"
@@ -873,6 +1069,27 @@
},
"type": "object"
},
"MinuteRange": {
"description": "A contiguous set of minutes: startMinutesAgo, startMinutesAgo + 1, ..., endMinutesAgo. Requests are allowed up to 2 minute ranges.",
"id": "MinuteRange",
"properties": {
"endMinutesAgo": {
"description": "The inclusive end minute for the query as a number of minutes before now. Cannot be before `startMinutesAgo`. For example, `\"endMinutesAgo\": 15` specifies the report should include event data from prior to 15 minutes ago. If unspecified, `endMinutesAgo` is defaulted to 0. Standard Analytics properties can request any minute in the last 30 minutes of event data (`endMinutesAgo <= 29`), and 360 Analytics properties can request any minute in the last 60 minutes of event data (`endMinutesAgo <= 59`).",
"format": "int32",
"type": "integer"
},
"name": {
"description": "Assigns a name to this minute range. The dimension `dateRange` is valued to this name in a report response. If set, cannot begin with `date_range_` or `RESERVED_`. If not set, minute ranges are named by their zero based index in the request: `date_range_0`, `date_range_1`, etc.",
"type": "string"
},
"startMinutesAgo": {
"description": "The inclusive start minute for the query as a number of minutes before now. For example, `\"startMinutesAgo\": 29` specifies the report should include event data from 29 minutes ago and after. Cannot be after `endMinutesAgo`. If unspecified, `startMinutesAgo` is defaulted to 29. Standard Analytics properties can request up to the last 30 minutes of event data (`startMinutesAgo <= 29`), and 360 Analytics properties can request up to the last 60 minutes of event data (`startMinutesAgo <= 59`).",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"NumericFilter": {
"description": "Filters for numeric or date values.",
"id": "NumericFilter",
@@ -1110,9 +1327,29 @@
"description": "Response's metadata carrying additional information about the report content.",
"id": "ResponseMetaData",
"properties": {
"currencyCode": {
"description": "The currency code used in this report. Intended to be used in formatting currency metrics like `purchaseRevenue` for visualization. If currency_code was specified in the request, this response parameter will echo the request parameter; otherwise, this response parameter is the property's current currency_code. Currency codes are string encodings of currency types from the ISO 4217 standard (https://en.wikipedia.org/wiki/ISO_4217); for example \"USD\", \"EUR\", \"JPY\". To learn more, see https://support.google.com/analytics/answer/9796179.",
"type": "string"
},
"dataLossFromOtherRow": {
"description": "If true, indicates some buckets of dimension combinations are rolled into \"(other)\" row. This can happen for high cardinality reports.",
"type": "boolean"
},
"emptyReason": {
"description": "If empty reason is specified, the report is empty for this reason.",
"type": "string"
},
"schemaRestrictionResponse": {
"$ref": "SchemaRestrictionResponse",
"description": "Describes the schema restrictions actively enforced in creating this report. To learn more, see [Access and data-restriction management](https://support.google.com/analytics/answer/10851388)."
},
"subjectToThresholding": {
"description": "If `subjectToThresholding` is true, this report is subject to thresholding and only returns data that meets the minimum aggregation thresholds. It is possible for a request to be subject to thresholding thresholding and no data is absent from the report, and this happens when all data is above the thresholds. To learn more, see [Data thresholds](https://support.google.com/analytics/answer/9383630) and [About Demographics and Interests](https://support.google.com/analytics/answer/2799357).",
"type": "boolean"
},
"timeZone": {
"description": "The property's current timezone. Intended to be used to interpret time-based dimensions like `hour` and `minute`. Formatted as strings from the IANA Time Zone database (https://www.iana.org/time-zones); for example \"America/New_York\" or \"Asia/Tokyo\".",
"type": "string"
}
},
"type": "object"
@@ -1307,6 +1544,13 @@
},
"type": "array"
},
"minuteRanges": {
"description": "The minute ranges of event data to read. If unspecified, one minute range for the last 30 minutes will be used. If multiple minute ranges are requested, each response row will contain a zero based minute range index. If two minute ranges overlap, the event data for the overlapping minutes is included in the response rows for both minute ranges.",
"items": {
"$ref": "MinuteRange"
},
"type": "array"
},
"orderBys": {
"description": "Specifies how rows are ordered in the response.",
"items": {
@@ -1404,7 +1648,7 @@
},
"dimensionFilter": {
"$ref": "FilterExpression",
"description": "The filter clause of dimensions. Dimensions must be requested to be used in this filter. Metrics cannot be used in this filter."
"description": "Dimension filters allow you to ask for only specific dimension values in the report. To learn more, see [Fundamentals of Dimension Filters](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#dimension_filters) for examples. Metrics cannot be used in this filter."
},
"dimensions": {
"description": "The dimensions requested and displayed.",
@@ -1445,7 +1689,7 @@
},
"metricFilter": {
"$ref": "FilterExpression",
"description": "The filter clause of metrics. Applied at post aggregation phase, similar to SQL having-clause. Metrics must be requested to be used in this filter. Dimensions cannot be used in this filter."
"description": "The filter clause of metrics. Applied after aggregating the report's rows, similar to SQL having-clause. Dimensions cannot be used in this filter."
},
"metrics": {
"description": "The metrics requested and displayed.",
@@ -1543,6 +1787,20 @@
},
"type": "object"
},
"SchemaRestrictionResponse": {
"description": "The schema restrictions actively enforced in creating this report. To learn more, see [Access and data-restriction management](https://support.google.com/analytics/answer/10851388).",
"id": "SchemaRestrictionResponse",
"properties": {
"activeMetricRestrictions": {
"description": "All restrictions actively enforced in creating the report. For example, `purchaseRevenue` always has the restriction type `REVENUE_DATA`. However, this active response restriction is only populated if the user's custom role disallows access to `REVENUE_DATA`.",
"items": {
"$ref": "ActiveMetricRestriction"
},
"type": "array"
}
},
"type": "object"
},
"StringFilter": {
"description": "The filter for string",
"id": "StringFilter",
@@ -1568,8 +1826,8 @@
"Begins with the string value.",
"Ends with the string value.",
"Contains the string value.",
"Full regular expression match with the string value.",
"Partial regular expression match with the string value."
"Full match for the regular expression with the string value.",
"Partial match for the regular expression with the string value."
],
"type": "string"
},

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

@@ -155,7 +155,7 @@
}
}
},
"revision": "20210310",
"revision": "20220215",
"rootUrl": "https://analyticsreporting.googleapis.com/",
"schemas": {
"Activity": {
@@ -1039,6 +1039,10 @@
"format": "google-datetime",
"type": "string"
},
"emptyReason": {
"description": "If empty reason is specified, the report is empty for this reason.",
"type": "string"
},
"isDataGolden": {
"description": "Indicates if response to this request is golden or not. Data is golden when the exact same request will not produce any new results if asked at a later point in time.",
"type": "boolean"

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

@@ -112,7 +112,7 @@
"type": "integer"
},
"pageToken": {
"description": "A token specifying which result page to return.",
"description": "A token specifying which result page to return. This field has custom validations in ListCustomersRequestValidator",
"location": "query",
"type": "string"
}
@@ -136,7 +136,7 @@
],
"parameters": {
"parent": {
"description": "Required. The customer that manages the configuration. An API resource name in the format `customers/[CUSTOMER_ID]`.",
"description": "Required. The customer that manages the configuration. An API resource name in the format `customers/[CUSTOMER_ID]`. This field has custom validation in CreateConfigurationRequestValidator",
"location": "path",
"pattern": "^customers/[^/]+$",
"required": true,
@@ -825,7 +825,7 @@
}
}
},
"revision": "20210331",
"revision": "20220305",
"rootUrl": "https://androiddeviceprovisioning.googleapis.com/",
"schemas": {
"ClaimDeviceRequest": {
@@ -913,18 +913,26 @@
"description": "Required. The name of the company. For example _XYZ Corp_. Displayed to the company's employees in the zero-touch enrollment portal.",
"type": "string"
},
"languageCode": {
"description": "Input only. The preferred locale of the customer represented as a BCP47 language code. This field is validated on input and requests containing unsupported language codes will be rejected. Supported language codes: Arabic (ar) Chinese (Hong Kong) (zh-HK) Chinese (Simplified) (zh-CN) Chinese (Traditional) (zh-TW) Czech (cs) Danish (da) Dutch (nl) English (UK) (en-GB) English (US) (en-US) Filipino (fil) Finnish (fi) French (fr) German (de) Hebrew (iw) Hindi (hi) Hungarian (hu) Indonesian (id) Italian (it) Japanese (ja) Korean (ko) Norwegian (Bokmal) (no) Polish (pl) Portuguese (Brazil) (pt-BR) Portuguese (Portugal) (pt-PT) Russian (ru) Spanish (es) Spanish (Latin America) (es-419) Swedish (sv) Thai (th) Turkish (tr) Ukrainian (uk) Vietnamese (vi)",
"type": "string"
},
"name": {
"description": "Output only. The API resource name of the company. The resource name is one of the following formats: * `partners/[PARTNER_ID]/customers/[CUSTOMER_ID]` * `partners/[PARTNER_ID]/vendors/[VENDOR_ID]` * `partners/[PARTNER_ID]/vendors/[VENDOR_ID]/customers/[CUSTOMER_ID]` Assigned by the server.",
"readOnly": true,
"type": "string"
},
"ownerEmails": {
"description": "Required. Input only. Email address of customer's users in the owner role. At least one `owner_email` is required. Each email address must be associated with a Google Account. Owners share the same access as admins but can also add, delete, and edit your organization's portal users.",
"description": "Required. Input only. Email address of customer's users in the owner role. At least one `owner_email` is required. Owners share the same access as admins but can also add, delete, and edit your organization's portal users.",
"items": {
"type": "string"
},
"type": "array"
},
"skipWelcomeEmail": {
"description": "Input only. If set to true, welcome email will not be sent to the customer. It is recommended to skip the welcome email if devices will be claimed with additional DEVICE_PROTECTION service, as the customer will receive separate emails at device claim time. This field is ignored if this is not a Zero-touch customer.",
"type": "boolean"
},
"termsStatus": {
"description": "Output only. Whether any user from the company has accepted the latest Terms of Service (ToS). See TermsStatus.",
"enum": [
@@ -1016,7 +1024,7 @@
},
"device": {
"$ref": "DeviceReference",
"description": "Required. The device the configuration is applied to."
"description": "Required. The device the configuration is applied to. There are custom validations in ApplyConfigurationRequestValidator"
}
},
"type": "object"
@@ -1091,7 +1099,7 @@
"properties": {
"device": {
"$ref": "DeviceReference",
"description": "Required. The device to remove the configuration from."
"description": "Required. The device to remove the configuration from. There are custom validations in RemoveConfigurationRequestValidator"
}
},
"type": "object"
@@ -1102,7 +1110,7 @@
"properties": {
"device": {
"$ref": "DeviceReference",
"description": "Required. The device to unclaim."
"description": "Required. The device to unclaim. There are custom validations in UnclaimDeviceRequestValidator."
}
},
"type": "object"
@@ -1149,6 +1157,18 @@
"description": "A record of a device claimed by a reseller for a customer. Devices claimed for zero-touch enrollment have a claim with the type `SECTION_TYPE_ZERO_TOUCH`. To learn more, read [Claim devices for customers](/zero-touch/guides/how-it-works#claim).",
"id": "DeviceClaim",
"properties": {
"additionalService": {
"description": "The Additional service registered for the device.",
"enum": [
"ADDITIONAL_SERVICE_UNSPECIFIED",
"DEVICE_PROTECTION"
],
"enumDescriptions": [
"No additional service.",
"Device protection service, also known as Android Enterprise Essentials. To claim a device with the device protection service you must enroll with the partnership team."
],
"type": "string"
},
"ownerCompanyId": {
"description": "The ID of the Customer that purchased the device.",
"format": "int64",

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

@@ -290,7 +290,7 @@
]
},
"update": {
"description": "Updates the device policy. To ensure the policy is properly enforced, you need to prevent unmanaged accounts from accessing Google Play by setting the allowed_accounts in the managed configuration for the Google Play package. See restrict accounts in Google Play.",
"description": "Updates the device policy. To ensure the policy is properly enforced, you need to prevent unmanaged accounts from accessing Google Play by setting the allowed_accounts in the managed configuration for the Google Play package. See restrict accounts in Google Play. When provisioning a new device, you should set the device policy using this method before adding the managed Google Play Account to the device, otherwise the policy will not be applied for a short period of time after adding the account to the device.",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}",
"httpMethod": "PUT",
"id": "androidenterprise.devices.update",
@@ -2610,7 +2610,7 @@
}
}
},
"revision": "20210324",
"revision": "20220303",
"rootUrl": "https://androidenterprise.googleapis.com/",
"schemas": {
"Administrator": {
@@ -2679,6 +2679,10 @@
"webApps": {
"$ref": "AdministratorWebTokenSpecWebApps",
"description": "Options for displaying the Web Apps page."
},
"zeroTouch": {
"$ref": "AdministratorWebTokenSpecZeroTouch",
"description": "Options for displaying the Zero Touch page."
}
},
"type": "object"
@@ -2737,6 +2741,16 @@
},
"type": "object"
},
"AdministratorWebTokenSpecZeroTouch": {
"id": "AdministratorWebTokenSpecZeroTouch",
"properties": {
"enabled": {
"description": "Whether zero-touch embedded UI is usable with this token. If enabled, the admin can link zero-touch customers to this enterprise.",
"type": "boolean"
}
},
"type": "object"
},
"AppRestrictionsSchema": {
"description": "Represents the list of app restrictions available to be pre-configured for the product.",
"id": "AppRestrictionsSchema",
@@ -3860,7 +3874,7 @@
"id": "Policy",
"properties": {
"autoUpdatePolicy": {
"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.",
"description": "Deprecated. Use autoUpdateMode instead. When autoUpdateMode is set to AUTO_UPDATE_POSTPONED or AUTO_UPDATE_HIGH_PRIORITY, this field has no effect. \"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.",
"enum": [
"autoUpdatePolicyUnspecified",
"choiceToTheUser",
@@ -4212,7 +4226,7 @@
],
"enumDescriptions": [
"Unspecified. Defaults to AUTO_UPDATE_DEFAULT.",
"The app is automatically updated with low priority to minimize the impact on the user. The app is updated when the following constraints are met: * The device is not actively used * The device is connected to a Wi-Fi network. * The device is charging * If the system update policy is set to `WINDOWED`: the local time of the device is within the daily maintenance window The device is notified about a new update within 24 hours after it is published by the developer, after which the app is updated the next time the constraints above are met.",
"The app is automatically updated with low priority to minimize the impact on the user. The app is updated when the following constraints are met: * The device is not actively used * The device is connected to an unmetered network * The device is charging The device is notified about a new update within 24 hours after it is published by the developer, after which the app is updated the next time the constraints above are met.",
"The app is not automatically updated for a maximum of 90 days after the app becomes out of date. 90 days after the app becomes out of date, the latest available version is installed automatically with low priority (see AUTO_UPDATE_DEFAULT). After the app is updated it is not automatically updated again until 90 days after it becomes out of date again. The user can still manually update the app from the Play Store at any time.",
"The app is updated as soon as possible. No constraints are applied. The device is notified immediately about a new app update after it is published by the developer."
],

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

@@ -115,12 +115,12 @@
"parameterOrder": [],
"parameters": {
"agreementAccepted": {
"description": "This feature is not generally available yet. Whether the managed Google Play Agreement is presented and agreed.",
"description": "Whether the enterprise admin has seen and agreed to the managed Google Play Agreement (https://www.android.com/enterprise/terms/). Always set this to true when creating an EMM-managed enterprise. Do not create the enterprise until the admin has viewed and accepted the agreement.",
"location": "query",
"type": "boolean"
},
"enterpriseToken": {
"description": "The enterprise token appended to the callback URL.",
"description": "The enterprise token appended to the callback URL. Only set this when creating a customer-managed enterprise.",
"location": "query",
"type": "string"
},
@@ -130,7 +130,7 @@
"type": "string"
},
"signupUrlName": {
"description": "The name of the SignupUrl used to sign up for the enterprise.",
"description": "The name of the SignupUrl used to sign up for the enterprise. Only set this when creating a customer-managed enterprise.",
"location": "query",
"type": "string"
}
@@ -147,7 +147,7 @@
]
},
"delete": {
"description": "This feature is not generally available yet. Deletes an enterprise.",
"description": "Deletes an enterprise. Only available for EMM-managed enterprises.",
"flatPath": "v1/enterprises/{enterprisesId}",
"httpMethod": "DELETE",
"id": "androidmanagement.enterprises.delete",
@@ -156,7 +156,7 @@
],
"parameters": {
"name": {
"description": "This feature is not generally available yet. The name of the enterprise in the form enterprises/{enterpriseId}.",
"description": "The name of the enterprise in the form enterprises/{enterpriseId}.",
"location": "path",
"pattern": "^enterprises/[^/]+$",
"required": true,
@@ -197,37 +197,37 @@
]
},
"list": {
"description": "This feature is not generally available yet. Lists enterprises that are managed by an EMM. Only partial views are returned.",
"description": "Lists EMM-managed enterprises. Only BASIC fields are returned.",
"flatPath": "v1/enterprises",
"httpMethod": "GET",
"id": "androidmanagement.enterprises.list",
"parameterOrder": [],
"parameters": {
"pageSize": {
"description": "This feature is not generally available yet. The requested page size. The actual page size may be fixed to a min or max value.",
"description": "The requested page size. The actual page size may be fixed to a min or max value.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "This feature is not generally available yet. A token identifying a page of results returned by the server.",
"description": "A token identifying a page of results returned by the server.",
"location": "query",
"type": "string"
},
"projectId": {
"description": "Required. This feature is not generally available yet. The ID of the Cloud project of the EMM the enterprises belongs to.",
"description": "Required. The Cloud project ID of the EMM managing the enterprises.",
"location": "query",
"type": "string"
},
"view": {
"description": "This feature is not generally available yet. View that specify that partial response should be returned.",
"description": "Specifies which Enterprise fields to return. This method only supports BASIC.",
"enum": [
"ENTERPRISE_VIEW_UNSPECIFIED",
"BASIC"
],
"enumDescriptions": [
"This feature is not generally available yet. The API will default to the BASIC view for the List method.",
"This feature is not generally available yet. Includes name and enterprise_display_name fields."
"The API will default to the BASIC view for the List method.",
"Includes name and enterprise_display_name fields."
],
"location": "query",
"type": "string"
@@ -877,7 +877,7 @@
],
"parameters": {
"pageSize": {
"description": "The requested page size. The actual page size may be fixed to a min or max value.",
"description": "The requested page size. This is a hint and the actual page size in the response may be different.",
"format": "int32",
"location": "query",
"type": "integer"
@@ -1004,11 +1004,11 @@
}
}
},
"revision": "20210322",
"revision": "20220302",
"rootUrl": "https://androidmanagement.googleapis.com/",
"schemas": {
"AdvancedSecurityOverrides": {
"description": "Security policies set to the most secure values by default. To maintain the security posture of a device, we don't recommend overriding any of the default values.",
"description": "Security policies set to secure values by default. To maintain the security posture of a device, we don't recommend overriding any of the default values.",
"id": "AdvancedSecurityOverrides",
"properties": {
"commonCriteriaMode": {
@@ -1025,6 +1025,41 @@
],
"type": "string"
},
"developerSettings": {
"description": "Controls access to developer settings: developer options and safe boot. Replaces safeBootDisabled (deprecated) and debuggingFeaturesAllowed (deprecated).",
"enum": [
"DEVELOPER_SETTINGS_UNSPECIFIED",
"DEVELOPER_SETTINGS_DISABLED",
"DEVELOPER_SETTINGS_ALLOWED"
],
"enumDescriptions": [
"Unspecified. Defaults to DEVELOPER_SETTINGS_DISABLED.",
"Default. Disables all developer settings and prevents the user from accessing them.",
"Allows all developer settings. The user can access and optionally configure the settings."
],
"type": "string"
},
"googlePlayProtectVerifyApps": {
"description": "Whether Google Play Protect verification (https://support.google.com/accounts/answer/2812853) is enforced. Replaces ensureVerifyAppsEnabled (deprecated).",
"enum": [
"GOOGLE_PLAY_PROTECT_VERIFY_APPS_UNSPECIFIED",
"VERIFY_APPS_ENFORCED",
"VERIFY_APPS_USER_CHOICE"
],
"enumDescriptions": [
"Unspecified. Defaults to VERIFY_APPS_ENFORCED.",
"Default. Force-enables app verification.",
"Allows the user to choose whether to enable app verification."
],
"type": "string"
},
"personalAppsThatCanReadWorkNotifications": {
"description": "Personal apps that can read work profile notifications using a NotificationListenerService (https://developer.android.com/reference/android/service/notification/NotificationListenerService). By default, no personal apps (aside from system apps) can read work notifications. Each value in the list must be a package name.",
"items": {
"type": "string"
},
"type": "array"
},
"untrustedAppsPolicy": {
"description": "The policy for untrusted apps (apps from unknown sources) enforced on the device. Replaces install_unknown_sources_allowed (deprecated).",
"enum": [
@@ -1086,10 +1121,53 @@
},
"type": "object"
},
"AppVersion": {
"description": "This represents a single version of the app.",
"id": "AppVersion",
"properties": {
"production": {
"description": "True if this version is a production track.",
"type": "boolean"
},
"trackIds": {
"description": "Track ids that the app version is published in. This doesn't include the production track (see production instead).",
"items": {
"type": "string"
},
"type": "array"
},
"versionCode": {
"description": "Unique increasing identifier for the app version.",
"format": "int32",
"type": "integer"
},
"versionString": {
"description": "The string used in the Play store by the app developer to identify the version. The string is not necessarily unique or localized (for example, the string could be \"1.4\").",
"type": "string"
}
},
"type": "object"
},
"Application": {
"description": "Information about an app.",
"id": "Application",
"properties": {
"appPricing": {
"description": "Whether this app is free, free with in-app purchases, or paid. If the pricing is unspecified, this means the app is not generally available anymore (even though it might still be available to people who own it).",
"enum": [
"APP_PRICING_UNSPECIFIED",
"FREE",
"FREE_WITH_IN_APP_PURCHASE",
"PAID"
],
"enumDescriptions": [
"Unknown pricing, used to denote an approved app that is not generally available.",
"The app is free.",
"The app is free, but offers in-app purchases.",
"The app is paid."
],
"type": "string"
},
"appTracks": {
"description": "Application tracks visible to the enterprise.",
"items": {
@@ -1097,6 +1175,91 @@
},
"type": "array"
},
"appVersions": {
"description": "Versions currently available for this app.",
"items": {
"$ref": "AppVersion"
},
"type": "array"
},
"author": {
"description": "The name of the author of the apps (for example, the app developer).",
"type": "string"
},
"availableCountries": {
"description": "The countries which this app is available in as per ISO 3166-1 alpha-2.",
"items": {
"type": "string"
},
"type": "array"
},
"category": {
"description": "The app category (e.g. RACING, SOCIAL, etc.)",
"type": "string"
},
"contentRating": {
"description": "The content rating for this app.",
"enum": [
"CONTENT_RATING_UNSPECIFIED",
"THREE_YEARS",
"SEVEN_YEARS",
"TWELVE_YEARS",
"SIXTEEN_YEARS",
"EIGHTEEN_YEARS"
],
"enumDescriptions": [
"Unspecified.",
"Content suitable for ages 3 and above only.",
"Content suitable for ages 7 and above only.",
"Content suitable for ages 12 and above only.",
"Content suitable for ages 16 and above only.",
"Content suitable for ages 18 and above only."
],
"type": "string"
},
"description": {
"description": "The localized promotional description, if available.",
"type": "string"
},
"distributionChannel": {
"description": "How and to whom the package is made available.",
"enum": [
"DISTRIBUTION_CHANNEL_UNSPECIFIED",
"PUBLIC_GOOGLE_HOSTED",
"PRIVATE_GOOGLE_HOSTED",
"PRIVATE_SELF_HOSTED"
],
"enumDescriptions": [
"Unspecified.",
"Package is available through the Play store and not restricted to a specific enterprise.",
"Package is a private app (restricted to an enterprise) but hosted by Google.",
"Private app (restricted to an enterprise) and is privately hosted."
],
"type": "string"
},
"features": {
"description": "Noteworthy features (if any) of this app.",
"items": {
"enum": [
"APP_FEATURE_UNSPECIFIED",
"VPN_APP"
],
"enumDescriptions": [
"Unspecified.",
"The app is a VPN."
],
"type": "string"
},
"type": "array"
},
"fullDescription": {
"description": "Full app description, if available.",
"type": "string"
},
"iconUrl": {
"description": "A link to an image that can be used as an icon for the app. This image is suitable for use at up to 512px x 512px",
"type": "string"
},
"managedProperties": {
"description": "The set of managed properties available to be pre-configured for the app.",
"items": {
@@ -1104,8 +1267,13 @@
},
"type": "array"
},
"minAndroidSdkVersion": {
"description": "The minimum Android SDK necessary to run the app.",
"format": "int32",
"type": "integer"
},
"name": {
"description": "The name of the app in the form enterprises/{enterpriseId}/applications/{package_name}.",
"description": "The name of the app in the form enterprises/{enterprise}/applications/{package_name}.",
"type": "string"
},
"permissions": {
@@ -1115,9 +1283,34 @@
},
"type": "array"
},
"playStoreUrl": {
"description": "A link to the (consumer) Google Play details page for the app.",
"type": "string"
},
"recentChanges": {
"description": "A localised description of the recent changes made to the app.",
"type": "string"
},
"screenshotUrls": {
"description": "A list of screenshot links representing the app.",
"items": {
"type": "string"
},
"type": "array"
},
"smallIconUrl": {
"description": "A link to a smaller image that can be used as an icon for the app. This image is suitable for use at up to 128px x 128px.",
"type": "string"
},
"title": {
"description": "The title of the app. Localized.",
"type": "string"
},
"updateTime": {
"description": "Output only. The approximate time (within 7 days) the app was last published.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
}
},
"type": "object"
@@ -1191,7 +1384,7 @@
"type": "array"
},
"autoUpdateMode": {
"description": "This feature is not generally available yet.",
"description": "Controls the auto-update mode for the app.",
"enum": [
"AUTO_UPDATE_MODE_UNSPECIFIED",
"AUTO_UPDATE_DEFAULT",
@@ -1199,10 +1392,10 @@
"AUTO_UPDATE_HIGH_PRIORITY"
],
"enumDescriptions": [
"This feature is not generally available yet.",
"This feature is not generally available yet.",
"This feature is not generally available yet.",
"This feature is not generally available yet."
"Unspecified. Defaults to AUTO_UPDATE_DEFAULT.",
"The app is automatically updated with low priority to minimize the impact on the user.The app is updated when all of the following constraints are met: The device is not actively used. The device is connected to an unmetered network. The device is charging.The device is notified about a new update within 24 hours after it is published by the developer, after which the app is updated the next time the constraints above are met.",
"The app is not automatically updated for a maximum of 90 days after the app becomes out of date.90 days after the app becomes out of date, the latest available version is installed automatically with low priority (see AUTO_UPDATE_DEFAULT). After the app is updated it is not automatically updated again until 90 days after it becomes out of date again.The user can still manually update the app from the Play Store at any time.",
"The app is updated as soon as possible. No constraints are applied.The device is notified immediately about a new update after it becomes available."
],
"type": "string"
},
@@ -1265,6 +1458,10 @@
"description": "Whether the app is disabled. When disabled, the app data is still preserved.",
"type": "boolean"
},
"extensionConfig": {
"$ref": "ExtensionConfig",
"description": "Configuration to enable this app as an extension app, with the capability of interacting with Android Device Policy offline.This field can be set for at most one app."
},
"installType": {
"description": "The type of installation to perform.",
"enum": [
@@ -1594,7 +1791,7 @@
"type": "object"
},
"ContactInfo": {
"description": "Contact details for LaForge enterprises.",
"description": "Contact details for managed Google Play enterprises.",
"id": "ContactInfo",
"properties": {
"contactEmail": {
@@ -1650,8 +1847,59 @@
},
"type": "object"
},
"CrossProfilePolicies": {
"description": "Cross-profile policies applied on the device.",
"id": "CrossProfilePolicies",
"properties": {
"crossProfileCopyPaste": {
"description": "Whether text copied from one profile (personal or work) can be pasted in the other profile.",
"enum": [
"CROSS_PROFILE_COPY_PASTE_UNSPECIFIED",
"COPY_FROM_WORK_TO_PERSONAL_DISALLOWED",
"CROSS_PROFILE_COPY_PASTE_ALLOWED"
],
"enumDescriptions": [
"Unspecified. Defaults to COPY_FROM_WORK_TO_PERSONAL_DISALLOWED",
"Default. Prevents users from pasting into the personal profile text copied from the work profile. Text copied from the personal profile can be pasted into the work profile, and text copied from the work profile can be pasted into the work profile.",
"Text copied in either profile can be pasted in the other profile."
],
"type": "string"
},
"crossProfileDataSharing": {
"description": "Whether data from one profile (personal or work) can be shared with apps in the other profile. Specifically controls simple data sharing via intents. Management of other cross-profile communication channels, such as contact search, copy/paste, or connected work & personal apps, are configured separately.",
"enum": [
"CROSS_PROFILE_DATA_SHARING_UNSPECIFIED",
"CROSS_PROFILE_DATA_SHARING_DISALLOWED",
"DATA_SHARING_FROM_WORK_TO_PERSONAL_DISALLOWED",
"CROSS_PROFILE_DATA_SHARING_ALLOWED"
],
"enumDescriptions": [
"Unspecified. Defaults to DATA_SHARING_FROM_WORK_TO_PERSONAL_DISALLOWED.",
"Prevents data from being shared from both the personal profile to the work profile and the work profile to the personal profile.",
"Default. Prevents users from sharing data from the work profile to apps in the personal profile. Personal data can be shared with work apps.",
"Data from either profile can be shared with the other profile."
],
"type": "string"
},
"showWorkContactsInPersonalProfile": {
"description": "Whether contacts stored in the work profile can be shown in personal profile contact searches and incoming calls.",
"enum": [
"SHOW_WORK_CONTACTS_IN_PERSONAL_PROFILE_UNSPECIFIED",
"SHOW_WORK_CONTACTS_IN_PERSONAL_PROFILE_DISALLOWED",
"SHOW_WORK_CONTACTS_IN_PERSONAL_PROFILE_ALLOWED"
],
"enumDescriptions": [
"Unspecified. Defaults to SHOW_WORK_CONTACTS_IN_PERSONAL_PROFILE_ALLOWED.",
"Prevents work profile contacts from appearing in personal profile contact searches and incoming calls",
"Default. Allows work profile contacts to appear in personal profile contact searches and incoming calls"
],
"type": "string"
}
},
"type": "object"
},
"Date": {
"description": "Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: A full date, with non-zero year, month, and day values A month and day value, with a zero year, such as an anniversary A year on its own, with zero month and day values A year and month value, with a zero day, such as a credit card expiration dateRelated types are google.type.TimeOfDay and google.protobuf.Timestamp.",
"description": "Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: A full date, with non-zero year, month, and day values A month and day, with a zero year (e.g., an anniversary) A year on its own, with a zero month and a zero day A year and month, with a zero day (e.g., a credit card expiration date)Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp",
"id": "Date",
"properties": {
"day": {
@@ -1688,6 +1936,13 @@
},
"type": "array"
},
"appliedPasswordPolicies": {
"description": "The password requirements currently applied to the device. The applied requirements may be slightly different from those specified in passwordPolicies in some cases. fieldPath is set based on passwordPolicies.",
"items": {
"$ref": "PasswordRequirements"
},
"type": "array"
},
"appliedPolicyName": {
"description": "The name of the policy currently applied to the device.",
"type": "string"
@@ -1710,7 +1965,7 @@
"This value is disallowed.",
"The device is active.",
"The device is disabled.",
"The device was deleted. This state will never be returned by an API call, but is used in the final status report published to Cloud Pub/Sub when the device acknowledges the deletion.",
"The device was deleted. This state is never returned by an API call, but is used in the final status report when the device acknowledges the deletion. If the device is deleted via the API call, this state is published to Pub/Sub. If the user deletes the work profile or resets the device, the device state will remain unknown to the server.",
"The device is being provisioned. Newly enrolled devices are in this state until they have a policy applied."
],
"type": "string"
@@ -1796,7 +2051,7 @@
},
"memoryInfo": {
"$ref": "MemoryInfo",
"description": "Memory information. This information is only available if memoryInfoEnabled is true in the device's policy."
"description": "Memory information: contains information about device memory and storage."
},
"name": {
"description": "The name of the device in the form enterprises/{enterpriseId}/devices/{deviceId}.",
@@ -1870,7 +2125,7 @@
"This value is disallowed.",
"The device is active.",
"The device is disabled.",
"The device was deleted. This state will never be returned by an API call, but is used in the final status report published to Cloud Pub/Sub when the device acknowledges the deletion.",
"The device was deleted. This state is never returned by an API call, but is used in the final status report when the device acknowledges the deletion. If the device is deleted via the API call, this state is published to Pub/Sub. If the user deletes the work profile or resets the device, the device state will remain unknown to the server.",
"The device is being provisioned. Newly enrolled devices are in this state until they have a policy applied."
],
"type": "string"
@@ -1940,7 +2195,7 @@
"type": "boolean"
},
"verifyAppsEnabled": {
"description": "Whether Verify Apps (Google Play Protect (https://support.google.com/googleplay/answer/2812853)) is enabled on the device.",
"description": "Whether Google Play Protect verification (https://support.google.com/accounts/answer/2812853) is enforced on the device.",
"type": "boolean"
}
},
@@ -2075,7 +2330,7 @@
},
"contactInfo": {
"$ref": "ContactInfo",
"description": "This feature is not generally available yet. The enterprise contact info of an EMM owned enterprise"
"description": "The enterprise contact info of an EMM-managed enterprise."
},
"enabledNotificationTypes": {
"description": "The types of Google Pub/Sub notifications enabled for the enterprise.",
@@ -2136,6 +2391,24 @@
},
"type": "object"
},
"ExtensionConfig": {
"description": "Configuration to enable an app as an extension app, with the capability of interacting with Android Device Policy offline.",
"id": "ExtensionConfig",
"properties": {
"notificationReceiver": {
"description": "Fully qualified class name of the receiver service class for Android Device Policy to notify the extension app of any local command status updates.",
"type": "string"
},
"signingKeyFingerprintsSha256": {
"description": "Hex-encoded SHA256 hash of the signing certificate of the extension app. Only hexadecimal string representations of 64 characters are valid.If not specified, the signature for the corresponding package name is obtained from the Play Store instead.If this list is empty, the signature of the extension app on the device must match the signature obtained from the Play Store for the app to be able to communicate with Android Device Policy.If this list is not empty, the signature of the extension app on the device must match one of the entries in this list for the app to be able to communicate with Android Device Policy.In production use cases, it is recommended to leave this empty.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ExternalData": {
"description": "Data hosted at an external location. The data is to be downloaded by Android Device Policy and verified against the hash.",
"id": "ExternalData",
@@ -2210,6 +2483,11 @@
"description": "Baseband version. For example, MDM9625_104662.22.05.34p.",
"type": "string"
},
"enterpriseSpecificId": {
"description": "Output only. ID that uniquely identifies a personally-owned device in a particular organization. On the same physical device when enrolled with the same organization, this ID persists across setups and even factory resets. This ID is available on personally-owned devices with a work profile on devices running Android 12 and above.",
"readOnly": true,
"type": "string"
},
"gpuShutdownTemperatures": {
"description": "GPU shutdown temperature thresholds in Celsius for each GPU on the device.",
"items": {
@@ -2321,6 +2599,12 @@
},
"type": "object"
},
"IssueCommandResponse": {
"description": "Response on issuing a command. This is currently empty as a placeholder.",
"id": "IssueCommandResponse",
"properties": {},
"type": "object"
},
"KeyedAppState": {
"description": "Keyed app state reported by the app.",
"id": "KeyedAppState",
@@ -2475,18 +2759,18 @@
"type": "object"
},
"ListEnterprisesResponse": {
"description": "This feature is not generally available yet. Response to a request to list enterprises.",
"description": "Response to a request to list enterprises.",
"id": "ListEnterprisesResponse",
"properties": {
"enterprises": {
"description": "This feature is not generally available yet. The list of enterprises.",
"description": "The list of enterprises.",
"items": {
"$ref": "Enterprise"
},
"type": "array"
},
"nextPageToken": {
"description": "This feature is not generally available yet. If there are more results, a token to retrieve next page of results.",
"description": "If there are more results, a token to retrieve next page of results.",
"type": "string"
}
},
@@ -2985,17 +3269,23 @@
"NUMERIC_COMPLEX",
"ALPHABETIC",
"ALPHANUMERIC",
"COMPLEX"
"COMPLEX",
"COMPLEXITY_LOW",
"COMPLEXITY_MEDIUM",
"COMPLEXITY_HIGH"
],
"enumDescriptions": [
"There are no password requirements.",
"The device must be secured with a low-security biometric recognition technology, at minimum. This includes technologies that can recognize the identity of an individual that are roughly equivalent to a 3-digit PIN (false detection is less than 1 in 1,000).",
"A password is required, but there are no restrictions on what the password must contain.",
"The password must contain numeric characters.",
"The password must contain numeric characters with no repeating (4444) or ordered (1234, 4321, 2468) sequences.",
"The password must contain alphabetic (or symbol) characters.",
"The password must contain both numeric and alphabetic (or symbol) characters.",
"The password must meet the minimum requirements specified in passwordMinimumLength, passwordMinimumLetters, passwordMinimumSymbols, etc. For example, if passwordMinimumSymbols is 2, the password must contain at least two symbols."
"The device must be secured with a low-security biometric recognition technology, at minimum. This includes technologies that can recognize the identity of an individual that are roughly equivalent to a 3-digit PIN (false detection is less than 1 in 1,000).This, when applied on personally owned work profile devices on Android 12 device-scoped, will be treated as COMPLEXITY_LOW for application. See PasswordQuality for details.",
"A password is required, but there are no restrictions on what the password must contain.This, when applied on personally owned work profile devices on Android 12 device-scoped, will be treated as COMPLEXITY_LOW for application. See PasswordQuality for details.",
"The password must contain numeric characters.This, when applied on personally owned work profile devices on Android 12 device-scoped, will be treated as COMPLEXITY_MEDIUM for application. See PasswordQuality for details.",
"The password must contain numeric characters with no repeating (4444) or ordered (1234, 4321, 2468) sequences.This, when applied on personally owned work profile devices on Android 12 device-scoped, will be treated as COMPLEXITY_MEDIUM for application. See PasswordQuality for details.",
"The password must contain alphabetic (or symbol) characters.This, when applied on personally owned work profile devices on Android 12 device-scoped, will be treated as COMPLEXITY_HIGH for application. See PasswordQuality for details.",
"The password must contain both numeric and alphabetic (or symbol) characters.This, when applied on personally owned work profile devices on Android 12 device-scoped, will be treated as COMPLEXITY_HIGH for application. See PasswordQuality for details.",
"The password must meet the minimum requirements specified in passwordMinimumLength, passwordMinimumLetters, passwordMinimumSymbols, etc. For example, if passwordMinimumSymbols is 2, the password must contain at least two symbols.This, when applied on personally owned work profile devices on Android 12 device-scoped, will be treated as COMPLEXITY_HIGH for application. In this case, the requirements in passwordMinimumLength, passwordMinimumLetters, passwordMinimumSymbols, etc are not applied. See PasswordQuality for details.",
"Define the low password complexity band as: pattern PIN with repeating (4444) or ordered (1234, 4321, 2468) sequencesThis sets the minimum complexity band which the password must meet.Enforcement varies among different Android versions, management modes and password scopes. See PasswordQuality for details.",
"Define the medium password complexity band as: PIN with no repeating (4444) or ordered (1234, 4321, 2468) sequences, length at least 4 alphabetic, length at least 4 alphanumeric, length at least 4This sets the minimum complexity band which the password must meet.Enforcement varies among different Android versions, management modes and password scopes. See PasswordQuality for details.",
"Define the high password complexity band as:On Android 12 and above: PIN with no repeating (4444) or ordered (1234, 4321, 2468) sequences, length at least 8 alphabetic, length at least 6 alphanumeric, length at least 6This sets the minimum complexity band which the password must meet.Enforcement varies among different Android versions, management modes and password scopes. See PasswordQuality for details."
],
"type": "string"
},
@@ -3026,6 +3316,20 @@
"The timeout period is set to 24 hours."
],
"type": "string"
},
"unifiedLockSettings": {
"description": "Controls whether a unified lock is allowed for the device and the work profile, on devices running Android 9 and above with a work profile. This has no effect on other devices. This can be set only if password_scope is set to SCOPE_PROFILE, the policy will be rejected otherwise. If user has not set a separate work lock and this field is set to REQUIRE_SEPARATE_WORK_LOCK, a NonComplianceDetail is reported with nonComplianceReason set to USER_ACTION.",
"enum": [
"UNIFIED_LOCK_SETTINGS_UNSPECIFIED",
"ALLOW_UNIFIED_WORK_AND_PERSONAL_LOCK",
"REQUIRE_SEPARATE_WORK_LOCK"
],
"enumDescriptions": [
"Unspecified. Defaults to ALLOW_UNIFIED_WORK_AND_PERSONAL_LOCK.",
"A common lock for the device and the work profile is allowed.",
"A separate lock for the work profile is required."
],
"type": "string"
}
},
"type": "object"
@@ -3178,7 +3482,7 @@
},
"advancedSecurityOverrides": {
"$ref": "AdvancedSecurityOverrides",
"description": "Security policies set to the most secure values by default. To maintain the security posture of a device, we don't recommend overriding any of the default values."
"description": "Security policies set to secure values by default. To maintain the security posture of a device, we don't recommend overriding any of the default values."
},
"alwaysOnVpnPackage": {
"$ref": "AlwaysOnVpnPackage",
@@ -3202,7 +3506,7 @@
"type": "array"
},
"appAutoUpdatePolicy": {
"description": "The app auto update policy, which controls when automatic app updates can be applied.",
"description": "Deprecated. Use autoUpdateMode instead.When autoUpdateMode is set to AUTO_UPDATE_POSTPONED or AUTO_UPDATE_HIGH_PRIORITY, this field has no effect.The app auto update policy, which controls when automatic app updates can be applied.",
"enum": [
"APP_AUTO_UPDATE_POLICY_UNSPECIFIED",
"CHOICE_TO_THE_USER",
@@ -3260,8 +3564,24 @@
"description": "Whether bluetooth is disabled. Prefer this setting over bluetooth_config_disabled because bluetooth_config_disabled can be bypassed by the user.",
"type": "boolean"
},
"cameraAccess": {
"description": "Controls the use of the camera and whether the user has access to the camera access toggle.",
"enum": [
"CAMERA_ACCESS_UNSPECIFIED",
"CAMERA_ACCESS_USER_CHOICE",
"CAMERA_ACCESS_DISABLED",
"CAMERA_ACCESS_ENFORCED"
],
"enumDescriptions": [
"If camera_disabled is true, this is equivalent to CAMERA_ACCESS_DISABLED. Otherwise, this is equivalent to CAMERA_ACCESS_USER_CHOICE.",
"The field camera_disabled is ignored. This is the default device behaviour: all cameras on the device are available. On Android 12 and above, the user can use the camera access toggle.",
"The field camera_disabled is ignored. All cameras on the device are disabled (for fully managed devices, this applies device-wide and for work profiles this applies only to the work profile).There are no explicit restrictions placed on the camera access toggle on Android 12 and above: on fully managed devices, the camera access toggle has no effect as all cameras are disabled. On devices with a work profile, this toggle has no effect on apps in the work profile, but it affects apps outside the work profile.",
"The field camera_disabled is ignored. All cameras on the device are available. On fully managed devices running Android 12 and above, the user is unable to use the camera access toggle. On devices which are not fully managed or which run Android 11 or below, this is equivalent to CAMERA_ACCESS_USER_CHOICE."
],
"type": "string"
},
"cameraDisabled": {
"description": "Whether all cameras on the device are disabled.",
"description": "If camera_access is set to any value other than CAMERA_ACCESS_UNSPECIFIED, this has no effect. Otherwise this field controls whether cameras are disabled: If true, all cameras are disabled, otherwise they are available. For fully managed devices this field applies for all apps on the device. For work profiles, this field applies only to apps in the work profile, and the camera access of apps outside the work profile is unaffected.",
"type": "boolean"
},
"cellBroadcastsConfigDisabled": {
@@ -3290,6 +3610,10 @@
"description": "Whether configuring user credentials is disabled.",
"type": "boolean"
},
"crossProfilePolicies": {
"$ref": "CrossProfilePolicies",
"description": "Cross-profile policies applied on the device."
},
"dataRoamingDisabled": {
"description": "Whether roaming data services are disabled.",
"type": "boolean"
@@ -3386,7 +3710,7 @@
"Disable unredacted notifications on secure keyguard screens.",
"Ignore trust agent state on secure keyguard screens.",
"Disable fingerprint sensor on secure keyguard screens.",
"Disable text entry into notifications on secure keyguard screens.",
"On devices running Android 6 and below, disables text entry into notifications on secure keyguard screens. Has no effect on Android 7 and above.",
"Disable face authentication on secure keyguard screens.",
"Disable iris authentication on secure keyguard screens.",
"Disable all biometric authentication on secure keyguard screens.",
@@ -3437,6 +3761,22 @@
"format": "int64",
"type": "string"
},
"microphoneAccess": {
"description": "Controls the use of the microphone and whether the user has access to the microphone access toggle. This applies only on fully managed devices.",
"enum": [
"MICROPHONE_ACCESS_UNSPECIFIED",
"MICROPHONE_ACCESS_USER_CHOICE",
"MICROPHONE_ACCESS_DISABLED",
"MICROPHONE_ACCESS_ENFORCED"
],
"enumDescriptions": [
"If unmute_microphone_disabled is true, this is equivalent to MICROPHONE_ACCESS_DISABLED. Otherwise, this is equivalent to MICROPHONE_ACCESS_USER_CHOICE.",
"The field unmute_microphone_disabled is ignored. This is the default device behaviour: the microphone on the device is available. On Android 12 and above, the user can use the microphone access toggle.",
"The field unmute_microphone_disabled is ignored. The microphone on the device is disabled (for fully managed devices, this applies device-wide).The microphone access toggle has no effect as the microphone is disabled.",
"The field unmute_microphone_disabled is ignored. The microphone on the device is available. On devices running Android 12 and above, the user is unable to use the microphone access toggle. On devices which run Android 11 or below, this is equivalent to MICROPHONE_ACCESS_USER_CHOICE."
],
"type": "string"
},
"minimumApiLevel": {
"description": "The minimum allowed Android API level.",
"format": "int32",
@@ -3459,7 +3799,7 @@
"type": "string"
},
"networkEscapeHatchEnabled": {
"description": "Whether the network escape hatch is enabled. If a network connection can't be made at boot time, the escape hatch prompts the user to temporarily connect to a network in order to refresh the device policy. After applying policy, the temporary network will be forgotten and the device will continue booting. This prevents being unable to connect to a network if there is no suitable network in the last policy and the device boots into an app in lock task mode, or the user is otherwise unable to reach device settings.",
"description": "Whether the network escape hatch is enabled. If a network connection can't be made at boot time, the escape hatch prompts the user to temporarily connect to a network in order to refresh the device policy. After applying policy, the temporary network will be forgotten and the device will continue booting. This prevents being unable to connect to a network if there is no suitable network in the last policy and the device boots into an app in lock task mode, or the user is otherwise unable to reach device settings.Note: Setting wifiConfigDisabled to true will override this setting under specific circumstances. Please see wifiConfigDisabled for further details.",
"type": "boolean"
},
"networkResetDisabled": {
@@ -3498,7 +3838,7 @@
},
"passwordRequirements": {
"$ref": "PasswordRequirements",
"description": "Password requirements. The field password_requirements.require_password_unlock must not be set. DEPRECATED - Use password_policies.Note:Complexity-based values of PasswordQuality, that is, COMPLEXITY_LOW, COMPLEXITY_MEDIUM, and COMPLEXITY_HIGH, cannot be used here."
"description": "Password requirements. The field password_requirements.require_password_unlock must not be set. DEPRECATED - Use passwordPolicies.Note:Complexity-based values of PasswordQuality, that is, COMPLEXITY_LOW, COMPLEXITY_MEDIUM, and COMPLEXITY_HIGH, cannot be used here. unified_lock_settings cannot be used here"
},
"permissionGrants": {
"description": "Explicit permission or group grants or denials for all apps. These values override the default_permission_policy.",
@@ -3547,6 +3887,20 @@
},
"type": "array"
},
"preferentialNetworkService": {
"description": "Controls whether preferential network service is enabled on the work profile. For example, an organization may have an agreement with a carrier that all of the work data from its employees' devices will be sent via a network service dedicated for enterprise use. An example of a supported preferential network service is the enterprise slice on 5G networks. This has no effect on fully managed devices.",
"enum": [
"PREFERENTIAL_NETWORK_SERVICE_UNSPECIFIED",
"PREFERENTIAL_NETWORK_SERVICE_DISABLED",
"PREFERENTIAL_NETWORK_SERVICE_ENABLED"
],
"enumDescriptions": [
"Unspecified. Defaults to PREFERENTIAL_NETWORK_SERVICES_DISABLED.",
"Preferential network service is disabled on the work profile.",
"Preferential network service is enabled on the work profile."
],
"type": "string"
},
"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"
@@ -3576,7 +3930,7 @@
"type": "boolean"
},
"setupActions": {
"description": "Actions to take during the setup process.",
"description": "Action to take during the setup process. At most one action may be specified.",
"items": {
"$ref": "SetupAction"
},
@@ -3638,7 +3992,7 @@
"type": "boolean"
},
"unmuteMicrophoneDisabled": {
"description": "Whether the microphone is muted and adjusting microphone volume is disabled.",
"description": "If microphone_access is set to any value other than MICROPHONE_ACCESS_UNSPECIFIED, this has no effect. Otherwise this field controls whether microphones are disabled: If true, all microphones are disabled, otherwise they are available. This is available only on fully managed devices.",
"type": "boolean"
},
"usbFileTransferDisabled": {
@@ -3659,7 +4013,7 @@
"type": "boolean"
},
"wifiConfigDisabled": {
"description": "Whether configuring Wi-Fi access points is disabled.",
"description": "Whether configuring Wi-Fi access points is disabled.Note: If a network connection can't be made at boot time and configuring Wi-Fi is disabled then network escape hatch will be shown in order to refresh the device policy (see networkEscapeHatchEnabled).",
"type": "boolean"
},
"wifiConfigsLockdownEnabled": {
@@ -3824,7 +4178,7 @@
},
"launchApp": {
"$ref": "LaunchAppAction",
"description": "An action to launch an app."
"description": "An action to launch an app. The app will be launched with an intent containing an extra with key com.google.android.apps.work.clouddpc.EXTRA_LAUNCHED_AS_SETUP_ACTION set to the boolean value true to indicate that this is a setup action flow."
},
"title": {
"$ref": "UserFacingMessage",
@@ -3990,7 +4344,7 @@
"type": "boolean"
},
"memoryInfoEnabled": {
"description": "Whether memory reporting is enabled.",
"description": "Whether memory event reporting is enabled.",
"type": "boolean"
},
"networkInfoEnabled": {
@@ -4044,7 +4398,7 @@
"enumDescriptions": [
"Follow the default update behavior for the device, which typically requires the user to accept system updates.",
"Install automatically as soon as an update is available.",
"Install automatically within a daily maintenance window. This also configures Play apps to be updated within the window. This is strongly recommended for kiosk devices because this is the only way apps persistently pinned to the foreground can be updated by Play.",
"Install automatically within a daily maintenance window. This also configures Play apps to be updated within the window. This is strongly recommended for kiosk devices because this is the only way apps persistently pinned to the foreground can be updated by Play.If autoUpdateMode is set to AUTO_UPDATE_HIGH_PRIORITY for an app, then the maintenance window is ignored for that app and it is updated as soon as possible even outside of the maintenance window.",
"Postpone automatic install up to a maximum of 30 days."
],
"type": "string"
@@ -4212,7 +4566,8 @@
"PRIVATE_APPS",
"WEB_APPS",
"STORE_BUILDER",
"MANAGED_CONFIGURATIONS"
"MANAGED_CONFIGURATIONS",
"ZERO_TOUCH_CUSTOMER_MANAGEMENT"
],
"enumDescriptions": [
"Unspecified feature.",
@@ -4220,7 +4575,8 @@
"The private apps page (https://developers.google.com/android/management/apps#private-apps).",
"The Web Apps page (https://developers.google.com/android/management/apps#web-apps).",
"The organize apps page (https://developers.google.com/android/management/apps#organize-apps).",
"The managed configurations page (https://developers.google.com/android/management/managed-configurations-iframe)."
"The managed configurations page (https://developers.google.com/android/management/managed-configurations-iframe).",
"The zero-touch iframe (https://developers.google.com/android/management/zero-touch-iframe)."
],
"type": "string"
},

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

File diff suppressed because it is too large Load Diff

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

@@ -29,6 +29,7 @@ api:
- v1
adsense:
- v1.4
- v2
adsensehost:
- v4.1
alertcenter:
@@ -54,6 +55,8 @@ api:
- v1
apigee:
- v1
apikeys:
- v2
appengine:
- v1
- v1beta4
@@ -69,8 +72,12 @@ api:
- v1beta1
assuredworkloads:
- v1
authorizedbuyersmarketplace:
- v1
autoscaler:
- v1beta2
baremetalsolution:
- v2
bigquery:
- v2
bigqueryconnection:
@@ -93,6 +100,8 @@ api:
- v1
calendar:
- v3
certificatemanager:
- v1
chat:
- v1
chromemanagement:
@@ -116,6 +125,8 @@ api:
- v1
clouddebugger:
- v2
clouddeploy:
- v1
clouderrorreporting:
- v1beta1
cloudfunctions:
@@ -149,6 +160,8 @@ api:
- v1
cloudshell:
- v1
cloudsupport:
- v2beta
cloudtasks:
- v2
- v2beta2
@@ -164,12 +177,17 @@ api:
- v1
compute:
- v1
connectors:
- v1
consumersurveys:
- v2
contactcenterinsights:
- v1
container:
- v1
containeranalysis:
- v1beta1
- v1
content:
- v2
- v2sandbox
@@ -179,6 +197,7 @@ api:
- v1
datacatalog:
- v1beta1
- v1
dataflow:
- v1b4
- v1b3
@@ -189,11 +208,17 @@ api:
- v1beta1
datamigration:
- v1
datapipelines:
- v1
dataplex:
- v1
dataproc:
- v1
datastore:
- v1
- v1beta3
datastream:
- v1
deploymentmanager:
- v2
- v2beta2
@@ -203,6 +228,7 @@ api:
- v3.2
- v3.3
- v3.4
- v3.5
dialogflow:
- v2
- v2beta1
@@ -218,6 +244,7 @@ api:
- v2beta1
dns:
- v1
- v2
docs:
- v1
documentai:
@@ -225,6 +252,7 @@ api:
- v1beta2
domains:
- v1beta1
- v1
domainsrdap:
- v1
doubleclickbidmanager:
@@ -237,17 +265,23 @@ api:
- v3
driveactivity:
- v2
essentialcontacts:
- v1
eventarc:
- v1
factchecktools:
- v1alpha1
fcm:
- v1
fcmdata:
- v1beta1
file:
- v1
- v1beta1
firebase:
- v1beta1
firebaseappcheck:
- v1beta
firebasedatabase:
- v1beta
firebasedynamiclinks:
@@ -305,13 +339,19 @@ api:
iap:
- v1
- v1beta1
ideahub:
- v1beta
identitytoolkit:
- v3
ids:
- v1
indexing:
- v3
jobs:
- v3
- v4
keep:
- v1
kgsearch:
- v1
language:
@@ -349,10 +389,29 @@ api:
- v4
mybusinessaccountmanagement:
- v1
mybusinessbusinesscalls:
- v1
mybusinessbusinessinformation:
- v1
mybusinesslodging:
- v1
mybusinessnotifications:
- v1
mybusinessplaceactions:
- v1
mybusinessqanda:
- v1
mybusinessverifications:
- v1
networkconnectivity:
- v1alpha1
- v1
networkmanagement:
- v1
networksecurity:
- v1
networkservices:
- v1
notebooks:
- v1
oauth2:
@@ -374,6 +433,8 @@ api:
- v5
partners:
- v2
paymentsresellersubscription:
- v1
people:
- v1
photoslibrary:
@@ -382,12 +443,16 @@ api:
- v3
playcustomapp:
- v1
playintegrity:
- v1
playmoviespartner:
- v1
plus:
- v1
plusdomains:
- v1
policyanalyzer:
- v1
policysimulator:
- v1
policytroubleshooter:
@@ -398,6 +463,7 @@ api:
- v1.6
privateca:
- v1beta1
- v1
prod_tt_sasportal:
- v1alpha1
proximitybeacon:
@@ -411,6 +477,8 @@ api:
- v1
realtimebidding:
- v1
recaptchaenterprise:
- v1
recommendationengine:
- v1beta1
recommender:
@@ -426,12 +494,15 @@ api:
- v1beta1
reseller:
- v1sandbox
resourcesettings:
- v1
resourceviews:
- v1beta2
retail:
- v2
run:
- v1
- v2
runtimeconfig:
- v1
- v1beta1
@@ -490,6 +561,7 @@ api:
- v1beta4
sqladmin:
- v1beta4
- v1
storage:
- v1
storagetransfer:
@@ -521,6 +593,7 @@ api:
- v2
transcoder:
- v1beta1
- v1
translate:
- v2
- v3
@@ -532,11 +605,15 @@ api:
- v1
verifiedaccess:
- v1
versionhistory:
- v1
videointelligence:
- v1
- v1beta1
vision:
- v1
vmmigration:
- v1
webfonts:
- v1
webmasters:

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

@@ -3,7 +3,7 @@
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "See, edit, configure, and delete your Google Cloud Platform data"
"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
}
}
}
@@ -155,7 +155,7 @@
"type": "string"
},
"pageSize": {
"description": "The maximum number of results to return. If not set, the service will select a default.",
"description": "The maximum number of results to return. If not set, the service selects a default.",
"format": "int32",
"location": "query",
"type": "integer"
@@ -271,7 +271,7 @@
],
"parameters": {
"options.requestedPolicyVersion": {
"description": "Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
"format": "int32",
"location": "query",
"type": "integer"
@@ -540,7 +540,7 @@
],
"parameters": {
"options.requestedPolicyVersion": {
"description": "Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
"format": "int32",
"location": "query",
"type": "integer"
@@ -796,7 +796,7 @@
],
"parameters": {
"options.requestedPolicyVersion": {
"description": "Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
"format": "int32",
"location": "query",
"type": "integer"
@@ -1083,7 +1083,7 @@
}
}
},
"revision": "20210318",
"revision": "20220223",
"rootUrl": "https://apigateway.googleapis.com/",
"schemas": {
"ApigatewayApi": {
@@ -1328,22 +1328,22 @@
"type": "object"
},
"ApigatewayBinding": {
"description": "Associates `members` with a `role`.",
"description": "Associates `members`, or principals, with a `role`.",
"id": "ApigatewayBinding",
"properties": {
"condition": {
"$ref": "ApigatewayExpr",
"description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)."
"description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)."
},
"members": {
"description": "Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ",
"description": "Specifies the principals requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ",
"items": {
"type": "string"
},
"type": "array"
},
"role": {
"description": "Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.",
"description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.",
"type": "string"
}
},
@@ -1691,7 +1691,7 @@
"type": "object"
},
"ApigatewayPolicy": {
"description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).",
"description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).",
"id": "ApigatewayPolicy",
"properties": {
"auditConfigs": {
@@ -1702,7 +1702,7 @@
"type": "array"
},
"bindings": {
"description": "Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.",
"description": "Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.",
"items": {
"$ref": "ApigatewayBinding"
},

24
etc/api/apigateway/v1beta/apigateway-api.json
View File

@@ -3,7 +3,7 @@
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "See, edit, configure, and delete your Google Cloud Platform data"
"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
}
}
}
@@ -155,7 +155,7 @@
"type": "string"
},
"pageSize": {
"description": "The maximum number of results to return. If not set, the service will select a default.",
"description": "The maximum number of results to return. If not set, the service selects a default.",
"format": "int32",
"location": "query",
"type": "integer"
@@ -271,7 +271,7 @@
],
"parameters": {
"options.requestedPolicyVersion": {
"description": "Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
"format": "int32",
"location": "query",
"type": "integer"
@@ -540,7 +540,7 @@
],
"parameters": {
"options.requestedPolicyVersion": {
"description": "Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
"format": "int32",
"location": "query",
"type": "integer"
@@ -796,7 +796,7 @@
],
"parameters": {
"options.requestedPolicyVersion": {
"description": "Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
"format": "int32",
"location": "query",
"type": "integer"
@@ -1083,7 +1083,7 @@
}
}
},
"revision": "20210318",
"revision": "20220223",
"rootUrl": "https://apigateway.googleapis.com/",
"schemas": {
"ApigatewayApi": {
@@ -1343,22 +1343,22 @@
"type": "object"
},
"ApigatewayBinding": {
"description": "Associates `members` with a `role`.",
"description": "Associates `members`, or principals, with a `role`.",
"id": "ApigatewayBinding",
"properties": {
"condition": {
"$ref": "ApigatewayExpr",
"description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)."
"description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)."
},
"members": {
"description": "Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ",
"description": "Specifies the principals requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ",
"items": {
"type": "string"
},
"type": "array"
},
"role": {
"description": "Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.",
"description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.",
"type": "string"
}
},
@@ -1717,7 +1717,7 @@
"type": "object"
},
"ApigatewayPolicy": {
"description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).",
"description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).",
"id": "ApigatewayPolicy",
"properties": {
"auditConfigs": {
@@ -1728,7 +1728,7 @@
"type": "array"
},
"bindings": {
"description": "Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.",
"description": "Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.",
"items": {
"$ref": "ApigatewayBinding"
},

2094
etc/api/apigee/v1/apigee-api.json
View File

File diff suppressed because it is too large Load Diff

735
etc/api/apikeys/v2/apikeys-api.json Normal file
View File

@@ -0,0 +1,735 @@
{
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
},
"https://www.googleapis.com/auth/cloud-platform.read-only": {
"description": "View your data across Google Cloud services and see the email address of your Google Account"
}
}
}
},
"basePath": "",
"baseUrl": "https://apikeys.googleapis.com/",
"batchPath": "batch",
"canonicalName": "Api Keys Service",
"description": "Manages the API keys associated with developer projects.",
"discoveryVersion": "v1",
"documentationLink": "https://cloud.google.com/api-keys/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": "apikeys:v2",
"kind": "discovery#restDescription",
"mtlsRootUrl": "https://apikeys.mtls.googleapis.com/",
"name": "apikeys",
"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": {
"keys": {
"methods": {
"lookupKey": {
"description": "Find the parent project and resource name of the API key that matches the key string in the request. If the API key has been purged, resource name will not be set. The service account must have the `apikeys.keys.lookup` permission on the parent project.",
"flatPath": "v2/keys:lookupKey",
"httpMethod": "GET",
"id": "apikeys.keys.lookupKey",
"parameterOrder": [],
"parameters": {
"keyString": {
"description": "Required. Finds the project that owns the key string value.",
"location": "query",
"type": "string"
}
},
"path": "v2/keys:lookupKey",
"response": {
"$ref": "V2LookupKeyResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
]
}
}
},
"operations": {
"methods": {
"get": {
"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
"flatPath": "v2/operations/{operationsId}",
"httpMethod": "GET",
"id": "apikeys.operations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource.",
"location": "path",
"pattern": "^operations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
]
}
}
},
"projects": {
"resources": {
"locations": {
"resources": {
"keys": {
"methods": {
"clone": {
"description": "DEPRECATED: API customers can call `GetKey` and then `CreateKey` methods to create a copy of an existing key. Retire `CloneKey` method to eliminate the unnessary method from API Keys API. Clones the existing key's restriction and display name to a new API key. The service account must have the `apikeys.keys.get` and `apikeys.keys.create` permissions in the project. NOTE: Key is a global resource; hence the only supported value for location is `global`.",
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/keys/{keysId}:clone",
"httpMethod": "POST",
"id": "apikeys.projects.locations.keys.clone",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the API key to be cloned in the same project.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/keys/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}:clone",
"request": {
"$ref": "V2CloneKeyRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"create": {
"description": "Creates a new API key. NOTE: Key is a global resource; hence the only supported value for location is `global`.",
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/keys",
"httpMethod": "POST",
"id": "apikeys.projects.locations.keys.create",
"parameterOrder": [
"parent"
],
"parameters": {
"keyId": {
"description": "User specified key id (optional). If specified, it will become the final component of the key resource name. The id must be unique within the project, must conform with RFC-1034, is restricted to lower-cased letters, and has a maximum length of 63 characters. In another word, the id must match the regular expression: `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`. The id must NOT be a UUID-like string.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The project in which the API key is created.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+parent}/keys",
"request": {
"$ref": "V2Key"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes an API key. Deleted key can be retrieved within 30 days of deletion. Afterward, key will be purged from the project. NOTE: Key is a global resource; hence the only supported value for location is `global`.",
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/keys/{keysId}",
"httpMethod": "DELETE",
"id": "apikeys.projects.locations.keys.delete",
"parameterOrder": [
"name"
],
"parameters": {
"etag": {
"description": "Optional. The etag known to the client for the expected state of the key. This is to be used for optimistic concurrency.",
"location": "query",
"type": "string"
},
"name": {
"description": "Required. The resource name of the API key to be deleted.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/keys/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets the metadata for an API key. The key string of the API key isn't included in the response. NOTE: Key is a global resource; hence the only supported value for location is `global`.",
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/keys/{keysId}",
"httpMethod": "GET",
"id": "apikeys.projects.locations.keys.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the API key to get.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/keys/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "V2Key"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
]
},
"getKeyString": {
"description": "Get the key string for an API key. NOTE: Key is a global resource; hence the only supported value for location is `global`.",
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/keys/{keysId}/keyString",
"httpMethod": "GET",
"id": "apikeys.projects.locations.keys.getKeyString",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the API key to be retrieved.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/keys/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}/keyString",
"response": {
"$ref": "V2GetKeyStringResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
]
},
"list": {
"description": "Lists the API keys owned by a project. The key string of the API key isn't included in the response. NOTE: Key is a global resource; hence the only supported value for location is `global`.",
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/keys",
"httpMethod": "GET",
"id": "apikeys.projects.locations.keys.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "Optional. Deprecated: Use `show_deleted` instead. Only list keys that conform to the specified filter. The allowed filter strings are `state:ACTIVE` and `state:DELETED`. By default, ListKeys returns only active keys.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Optional. Specifies the maximum number of results to be returned at a time.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. Requests a specific page of results.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. Lists all API keys associated with this project.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
},
"showDeleted": {
"description": "Optional. Indicate that keys are marked as deleted within 30 days should also be returned. Normally only active keys are returned.",
"location": "query",
"type": "boolean"
}
},
"path": "v2/{+parent}/keys",
"response": {
"$ref": "V2ListKeysResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
]
},
"patch": {
"description": "Patches the modifiable fields of an API key. The key string of the API key isn't included in the response. NOTE: Key is a global resource; hence the only supported value for location is `global`.",
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/keys/{keysId}",
"httpMethod": "PATCH",
"id": "apikeys.projects.locations.keys.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Output only. The resource name of the key. The `name` has the form: `projects//locations/global/keys/`. For example: `projects/123456867718/locations/global/keys/b7ff1f9f-8275-410a-94dd-3855ee9b5dd2` NOTE: Key is a global resource; hence the only supported value for location is `global`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/keys/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "The field mask specifies which fields to be updated as part of this request. All other fields are ignored. Mutable fields are: `display_name` and `restrictions`. If an update mask is not provided, the service treats it as an implied mask equivalent to all allowed fields that are set on the wire. If the field mask has a special value \"*\", the service treats it equivalent to replace all allowed mutable fields.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v2/{+name}",
"request": {
"$ref": "V2Key"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"undelete": {
"description": "Undeletes an API key which was deleted within 30 days. NOTE: Key is a global resource; hence the only supported value for location is `global`.",
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/keys/{keysId}:undelete",
"httpMethod": "POST",
"id": "apikeys.projects.locations.keys.undelete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the API key to be undeleted.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/keys/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}:undelete",
"request": {
"$ref": "V2UndeleteKeyRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
}
}
}
},
"revision": "20220305",
"rootUrl": "https://apikeys.googleapis.com/",
"schemas": {
"Operation": {
"description": "This resource represents a long-running operation that is the result of a network API call.",
"id": "Operation",
"properties": {
"done": {
"description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.",
"type": "boolean"
},
"error": {
"$ref": "Status",
"description": "The error result of the operation in case of failure or cancellation."
},
"metadata": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.",
"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 be a resource name ending with `operations/{unique_id}`.",
"type": "string"
},
"response": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"description": "The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.",
"type": "object"
}
},
"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). 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": {
"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 message 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 user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.",
"type": "string"
}
},
"type": "object"
},
"V2AndroidApplication": {
"description": "Identifier of an Android application for key use.",
"id": "V2AndroidApplication",
"properties": {
"packageName": {
"description": "The package name of the application.",
"type": "string"
},
"sha1Fingerprint": {
"description": "The SHA1 fingerprint of the application. For example, both sha1 formats are acceptable : DA:39:A3:EE:5E:6B:4B:0D:32:55:BF:EF:95:60:18:90:AF:D8:07:09 or DA39A3EE5E6B4B0D3255BFEF95601890AFD80709. Output format is the latter.",
"type": "string"
}
},
"type": "object"
},
"V2AndroidKeyRestrictions": {
"description": "The Android apps that are allowed to use the key.",
"id": "V2AndroidKeyRestrictions",
"properties": {
"allowedApplications": {
"description": "A list of Android applications that are allowed to make API calls with this key.",
"items": {
"$ref": "V2AndroidApplication"
},
"type": "array"
}
},
"type": "object"
},
"V2ApiTarget": {
"description": "A restriction for a specific service and optionally one or multiple specific methods. Both fields are case insensitive.",
"id": "V2ApiTarget",
"properties": {
"methods": {
"description": "Optional. List of one or more methods that can be called. If empty, all methods for the service are allowed. A wildcard (*) can be used as the last symbol. Valid examples: `google.cloud.translate.v2.TranslateService.GetSupportedLanguage` `TranslateText` `Get*` `translate.googleapis.com.Get*`",
"items": {
"type": "string"
},
"type": "array"
},
"service": {
"description": "The service for this restriction. It should be the canonical service name, for example: `translate.googleapis.com`. You can use [`gcloud services list`](/sdk/gcloud/reference/services/list) to get a list of services that are enabled in the project.",
"type": "string"
}
},
"type": "object"
},
"V2BrowserKeyRestrictions": {
"description": "The HTTP referrers (websites) that are allowed to use the key.",
"id": "V2BrowserKeyRestrictions",
"properties": {
"allowedReferrers": {
"description": "A list of regular expressions for the referrer URLs that are allowed to make API calls with this key.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"V2CloneKeyRequest": {
"description": "Request message for `CloneKey` method.",
"id": "V2CloneKeyRequest",
"properties": {
"keyId": {
"description": "User specified key id (optional). If specified, it will become the final component of the key resource name. The id must be unique within the project, must conform with RFC-1034, is restricted to lower-cased letters, and has a maximum length of 63 characters. In another word, the id must match the regular expression: `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`. The id must NOT be a UUID-like string.",
"type": "string"
}
},
"type": "object"
},
"V2GetKeyStringResponse": {
"description": "Response message for `GetKeyString` method.",
"id": "V2GetKeyStringResponse",
"properties": {
"keyString": {
"description": "An encrypted and signed value of the key.",
"type": "string"
}
},
"type": "object"
},
"V2IosKeyRestrictions": {
"description": "The iOS apps that are allowed to use the key.",
"id": "V2IosKeyRestrictions",
"properties": {
"allowedBundleIds": {
"description": "A list of bundle IDs that are allowed when making API calls with this key.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"V2Key": {
"description": "The representation of a key managed by the API Keys API.",
"id": "V2Key",
"properties": {
"createTime": {
"description": "Output only. A timestamp identifying the time this key was originally created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"deleteTime": {
"description": "Output only. A timestamp when this key was deleted. If the resource is not deleted, this must be empty.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"displayName": {
"description": "Human-readable display name of this key that you can modify. The maximum length is 63 characters.",
"type": "string"
},
"etag": {
"description": "Output only. A checksum computed by the server based on the current value of the Key resource. This may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. See https://google.aip.dev/154.",
"readOnly": true,
"type": "string"
},
"keyString": {
"description": "Output only. An encrypted and signed value held by this key. This field can be accessed only through the `GetKeyString` method.",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Output only. The resource name of the key. The `name` has the form: `projects//locations/global/keys/`. For example: `projects/123456867718/locations/global/keys/b7ff1f9f-8275-410a-94dd-3855ee9b5dd2` NOTE: Key is a global resource; hence the only supported value for location is `global`.",
"readOnly": true,
"type": "string"
},
"restrictions": {
"$ref": "V2Restrictions",
"description": "Key restrictions."
},
"uid": {
"description": "Output only. Unique id in UUID4 format.",
"readOnly": true,
"type": "string"
},
"updateTime": {
"description": "Output only. A timestamp identifying the time this key was last updated.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"V2ListKeysResponse": {
"description": "Response message for `ListKeys` method.",
"id": "V2ListKeysResponse",
"properties": {
"keys": {
"description": "A list of API keys.",
"items": {
"$ref": "V2Key"
},
"type": "array"
},
"nextPageToken": {
"description": "The pagination token for the next page of results.",
"type": "string"
}
},
"type": "object"
},
"V2LookupKeyResponse": {
"description": "Response message for `LookupKey` method.",
"id": "V2LookupKeyResponse",
"properties": {
"name": {
"description": "The resource name of the API key. If the API key has been purged, resource name is empty.",
"type": "string"
},
"parent": {
"description": "The project that owns the key with the value specified in the request.",
"type": "string"
}
},
"type": "object"
},
"V2Restrictions": {
"description": "Describes the restrictions on the key.",
"id": "V2Restrictions",
"properties": {
"androidKeyRestrictions": {
"$ref": "V2AndroidKeyRestrictions",
"description": "The Android apps that are allowed to use the key."
},
"apiTargets": {
"description": "A restriction for a specific service and optionally one or more specific methods. Requests are allowed if they match any of these restrictions. If no restrictions are specified, all targets are allowed.",
"items": {
"$ref": "V2ApiTarget"
},
"type": "array"
},
"browserKeyRestrictions": {
"$ref": "V2BrowserKeyRestrictions",
"description": "The HTTP referrers (websites) that are allowed to use the key."
},
"iosKeyRestrictions": {
"$ref": "V2IosKeyRestrictions",
"description": "The iOS apps that are allowed to use the key."
},
"serverKeyRestrictions": {
"$ref": "V2ServerKeyRestrictions",
"description": "The IP addresses of callers that are allowed to use the key."
}
},
"type": "object"
},
"V2ServerKeyRestrictions": {
"description": "The IP addresses of callers that are allowed to use the key.",
"id": "V2ServerKeyRestrictions",
"properties": {
"allowedIps": {
"description": "A list of the caller IP addresses that are allowed to make API calls with this key.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"V2UndeleteKeyRequest": {
"description": "Request message for `UndeleteKey` method.",
"id": "V2UndeleteKeyRequest",
"properties": {},
"type": "object"
}
},
"servicePath": "",
"title": "API Keys API",
"version": "v2",
"version_module": true
}

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

@@ -6,10 +6,10 @@
"description": "View and manage your applications deployed on Google App Engine"
},
"https://www.googleapis.com/auth/cloud-platform": {
"description": "See, edit, configure, and delete your Google Cloud Platform data"
"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
},
"https://www.googleapis.com/auth/cloud-platform.read-only": {
"description": "View your data across Google Cloud Platform services"
"description": "View your data across Google Cloud services and see the email address of your Google Account"
}
}
}
@@ -20,6 +20,7 @@
"description": "Provisions and manages developers' App Engine applications.",
"discoveryVersion": "v1",
"documentationLink": "https://cloud.google.com/appengine/docs/admin-api/",
"fullyEncodeReservedExpansion": true,
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
@@ -156,7 +157,7 @@
]
},
"patch": {
"description": "Updates the specified Application resource. You can update the following fields: auth_domain - Google authentication domain for controlling user access to the application. default_cookie_expiration - Cookie expiration policy for the application.",
"description": "Updates the specified Application resource. You can update the following fields: auth_domain - Google authentication domain for controlling user access to the application. default_cookie_expiration - Cookie expiration policy for the application. iap - Identity-Aware Proxy properties for the application.",
"flatPath": "v1/apps/{appsId}",
"httpMethod": "PATCH",
"id": "appengine.apps.patch",
@@ -171,7 +172,7 @@
"type": "string"
},
"updateMask": {
"description": "Standard field mask for the set of fields to be updated.",
"description": "Required. Standard field mask for the set of fields to be updated.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
@@ -624,7 +625,7 @@
"type": "string"
},
"updateMask": {
"description": "Standard field mask for the set of fields to be updated.",
"description": "Required. Standard field mask for the set of fields to be updated.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
@@ -907,7 +908,7 @@
"type": "string"
},
"pageSize": {
"description": "The maximum number of results to return. If not set, the service will select a default.",
"description": "The maximum number of results to return. If not set, the service selects a default.",
"format": "int32",
"location": "query",
"type": "integer"
@@ -1140,7 +1141,7 @@
"type": "string"
},
"updateMask": {
"description": "Standard field mask for the set of fields to be updated.",
"description": "Required. Standard field mask for the set of fields to be updated.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
@@ -1594,7 +1595,7 @@
}
}
},
"revision": "20210324",
"revision": "20220226",
"rootUrl": "https://appengine.googleapis.com/",
"schemas": {
"ApiConfigHandler": {
@@ -1742,6 +1743,10 @@
"description": "Full path to the Application resource in the API. Example: apps/myapp.@OutputOnly",
"type": "string"
},
"serviceAccount": {
"description": "The service account associated with the application. This is the app-level default identity. If no identity provided during create version, Admin API will fallback to this one.",
"type": "string"
},
"servingStatus": {
"description": "Serving status of this application.",
"enum": [
@@ -2257,7 +2262,7 @@
"type": "string"
},
"description": {
"description": "An optional string description of this rule. This field has a maximum length of 100 characters.",
"description": "An optional string description of this rule. This field has a maximum length of 400 characters.",
"type": "string"
},
"priority": {
@@ -2272,6 +2277,26 @@
},
"type": "object"
},
"GoogleAppengineV1betaLocationMetadata": {
"description": "Metadata for the given google.cloud.location.Location.",
"id": "GoogleAppengineV1betaLocationMetadata",
"properties": {
"flexibleEnvironmentAvailable": {
"description": "App Engine flexible environment is available in the given location.@OutputOnly",
"type": "boolean"
},
"searchApiAvailable": {
"description": "Output only. Search API (https://cloud.google.com/appengine/docs/standard/python/search) is available in the given location.",
"readOnly": true,
"type": "boolean"
},
"standardEnvironmentAvailable": {
"description": "App Engine standard environment is available in the given location.@OutputOnly",
"type": "boolean"
}
},
"type": "object"
},
"HealthCheck": {
"description": "Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Only applicable for instances in App Engine flexible environment.",
"id": "HealthCheck",
@@ -3166,6 +3191,13 @@
"description": "Relative name of the service within the application. Example: default.@OutputOnly",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "A set of labels to apply to this service. Labels are key/value pairs that describe the service and all resources that belong to it (e.g., versions). The labels can be used to search and group resources, and are propagated to the usage and billing reports, enabling fine-grain analysis of costs. An example of using labels is to tag resources belonging to different environments (e.g., \"env=prod\", \"env=qa\"). Label keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores, dashes, and international characters. Label keys must start with a lowercase letter or an international character. Each service can have at most 32 labels.",
"type": "object"
},
"name": {
"description": "Full path to the Service resource in the API. Example: apps/myapp/services/default.@OutputOnly",
"type": "string"
@@ -3688,6 +3720,20 @@
"description": "VPC access connector specification.",
"id": "VpcAccessConnector",
"properties": {
"egressSetting": {
"description": "The egress setting for the connector, controlling what traffic is diverted through it.",
"enum": [
"EGRESS_SETTING_UNSPECIFIED",
"ALL_TRAFFIC",
"PRIVATE_IP_RANGES"
],
"enumDescriptions": [
"",
"Force the use of VPC Access for all egress traffic from the function.",
"Use the VPC Access Connector for private IP space from RFC1918."
],
"type": "string"
},
"name": {
"description": "Full Serverless VPC Access Connector name e.g. /projects/my-project/locations/us-central1/connectors/c1.",
"type": "string"

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

@@ -6,10 +6,10 @@
"description": "View and manage your applications deployed on Google App Engine"
},
"https://www.googleapis.com/auth/cloud-platform": {
"description": "See, edit, configure, and delete your Google Cloud Platform data"
"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
},
"https://www.googleapis.com/auth/cloud-platform.read-only": {
"description": "View your data across Google Cloud Platform services"
"description": "View your data across Google Cloud services and see the email address of your Google Account"
}
}
}
@@ -20,6 +20,7 @@
"description": "Provisions and manages developers' App Engine applications.",
"discoveryVersion": "v1",
"documentationLink": "https://cloud.google.com/appengine/docs/admin-api/",
"fullyEncodeReservedExpansion": true,
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
@@ -528,7 +529,7 @@
"type": "boolean"
},
"updateMask": {
"description": "Standard field mask for the set of fields to be updated.",
"description": "Required. Standard field mask for the set of fields to be updated.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
@@ -603,7 +604,7 @@
"type": "string"
},
"pageSize": {
"description": "The maximum number of results to return. If not set, the service will select a default.",
"description": "The maximum number of results to return. If not set, the service selects a default.",
"format": "int32",
"location": "query",
"type": "integer"
@@ -706,9 +707,187 @@
}
}
}
},
"projects": {
"resources": {
"locations": {
"methods": {
"get": {
"description": "Gets information about a location.",
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}",
"httpMethod": "GET",
"id": "appengine.projects.locations.get",
"parameterOrder": [
"projectsId",
"locationsId"
],
"parameters": {
"locationsId": {
"description": "Part of `name`. See documentation of `projectsId`.",
"location": "path",
"required": true,
"type": "string"
},
"projectsId": {
"description": "Part of `name`. Resource name for the location.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "v1alpha/projects/{projectsId}/locations/{locationsId}",
"response": {
"$ref": "Location"
},
"scopes": [
"https://www.googleapis.com/auth/appengine.admin",
"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": "v1alpha/projects/{projectsId}/locations",
"httpMethod": "GET",
"id": "appengine.projects.locations.list",
"parameterOrder": [
"projectsId"
],
"parameters": {
"filter": {
"description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like \"displayName=tokyo\", and is documented in more detail in AIP-160 (https://google.aip.dev/160).",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "The maximum number of results to return. If not set, the service selects a default.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A page token received from the next_page_token field in the response. Send that page token to receive the subsequent page.",
"location": "query",
"type": "string"
},
"projectsId": {
"description": "Part of `name`. The resource that owns the locations collection, if applicable.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "v1alpha/projects/{projectsId}/locations",
"response": {
"$ref": "ListLocationsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/appengine.admin",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
]
}
},
"resources": {
"operations": {
"methods": {
"get": {
"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}",
"httpMethod": "GET",
"id": "appengine.projects.locations.operations.get",
"parameterOrder": [
"projectsId",
"locationsId",
"operationsId"
],
"parameters": {
"locationsId": {
"description": "Part of `name`. See documentation of `projectsId`.",
"location": "path",
"required": true,
"type": "string"
},
"operationsId": {
"description": "Part of `name`. See documentation of `projectsId`.",
"location": "path",
"required": true,
"type": "string"
},
"projectsId": {
"description": "Part of `name`. The name of the operation resource.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "v1alpha/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/appengine.admin",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
]
},
"list": {
"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as \"/v1/{name=users/*}/operations\" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.",
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/operations",
"httpMethod": "GET",
"id": "appengine.projects.locations.operations.list",
"parameterOrder": [
"projectsId",
"locationsId"
],
"parameters": {
"filter": {
"description": "The standard list filter.",
"location": "query",
"type": "string"
},
"locationsId": {
"description": "Part of `name`. See documentation of `projectsId`.",
"location": "path",
"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"
},
"projectsId": {
"description": "Part of `name`. The name of the operation's parent resource.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "v1alpha/projects/{projectsId}/locations/{locationsId}/operations",
"response": {
"$ref": "ListOperationsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/appengine.admin",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
]
}
}
}
}
}
}
}
},
"revision": "20210324",
"revision": "20220226",
"rootUrl": "https://appengine.googleapis.com/",
"schemas": {
"AuthorizedCertificate": {
@@ -857,6 +1036,26 @@
"properties": {},
"type": "object"
},
"GoogleAppengineV1betaLocationMetadata": {
"description": "Metadata for the given google.cloud.location.Location.",
"id": "GoogleAppengineV1betaLocationMetadata",
"properties": {
"flexibleEnvironmentAvailable": {
"description": "App Engine flexible environment is available in the given location.@OutputOnly",
"type": "boolean"
},
"searchApiAvailable": {
"description": "Output only. Search API (https://cloud.google.com/appengine/docs/standard/python/search) is available in the given location.",
"readOnly": true,
"type": "boolean"
},
"standardEnvironmentAvailable": {
"description": "App Engine standard environment is available in the given location.@OutputOnly",
"type": "boolean"
}
},
"type": "object"
},
"ListAuthorizedCertificatesResponse": {
"description": "Response message for AuthorizedCertificates.ListAuthorizedCertificates.",
"id": "ListAuthorizedCertificatesResponse",

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

@@ -6,10 +6,10 @@
"description": "View and manage your applications deployed on Google App Engine"
},
"https://www.googleapis.com/auth/cloud-platform": {
"description": "See, edit, configure, and delete your Google Cloud Platform data"
"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
},
"https://www.googleapis.com/auth/cloud-platform.read-only": {
"description": "View your data across Google Cloud Platform services"
"description": "View your data across Google Cloud services and see the email address of your Google Account"
}
}
}
@@ -20,6 +20,7 @@
"description": "Provisions and manages developers' App Engine applications.",
"discoveryVersion": "v1",
"documentationLink": "https://cloud.google.com/appengine/docs/admin-api/",
"fullyEncodeReservedExpansion": true,
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
@@ -156,7 +157,7 @@
]
},
"patch": {
"description": "Updates the specified Application resource. You can update the following fields: auth_domain - Google authentication domain for controlling user access to the application. default_cookie_expiration - Cookie expiration policy for the application.",
"description": "Updates the specified Application resource. You can update the following fields: auth_domain - Google authentication domain for controlling user access to the application. default_cookie_expiration - Cookie expiration policy for the application. iap - Identity-Aware Proxy properties for the application.",
"flatPath": "v1beta/apps/{appsId}",
"httpMethod": "PATCH",
"id": "appengine.apps.patch",
@@ -171,7 +172,7 @@
"type": "string"
},
"updateMask": {
"description": "Standard field mask for the set of fields to be updated.",
"description": "Required. Standard field mask for the set of fields to be updated.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
@@ -624,7 +625,7 @@
"type": "string"
},
"updateMask": {
"description": "Standard field mask for the set of fields to be updated.",
"description": "Required. Standard field mask for the set of fields to be updated.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
@@ -907,7 +908,7 @@
"type": "string"
},
"pageSize": {
"description": "The maximum number of results to return. If not set, the service will select a default.",
"description": "The maximum number of results to return. If not set, the service selects a default.",
"format": "int32",
"location": "query",
"type": "integer"
@@ -1140,7 +1141,7 @@
"type": "string"
},
"updateMask": {
"description": "Standard field mask for the set of fields to be updated.",
"description": "Required. Standard field mask for the set of fields to be updated.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
@@ -1594,7 +1595,7 @@
}
}
},
"revision": "20210324",
"revision": "20220226",
"rootUrl": "https://appengine.googleapis.com/",
"schemas": {
"ApiConfigHandler": {
@@ -1742,6 +1743,10 @@
"description": "Full path to the Application resource in the API. Example: apps/myapp.@OutputOnly",
"type": "string"
},
"serviceAccount": {
"description": "The service account associated with the application. This is the app-level default identity. If no identity provided during create version, Admin API will fallback to this one.",
"type": "string"
},
"servingStatus": {
"description": "Serving status of this application.",
"enum": [
@@ -2308,7 +2313,7 @@
"type": "string"
},
"description": {
"description": "An optional string description of this rule. This field has a maximum length of 100 characters.",
"description": "An optional string description of this rule. This field has a maximum length of 400 characters.",
"type": "string"
},
"priority": {
@@ -2323,6 +2328,26 @@
},
"type": "object"
},
"GoogleAppengineV1betaLocationMetadata": {
"description": "Metadata for the given google.cloud.location.Location.",
"id": "GoogleAppengineV1betaLocationMetadata",
"properties": {
"flexibleEnvironmentAvailable": {
"description": "App Engine flexible environment is available in the given location.@OutputOnly",
"type": "boolean"
},
"searchApiAvailable": {
"description": "Output only. Search API (https://cloud.google.com/appengine/docs/standard/python/search) is available in the given location.",
"readOnly": true,
"type": "boolean"
},
"standardEnvironmentAvailable": {
"description": "App Engine standard environment is available in the given location.@OutputOnly",
"type": "boolean"
}
},
"type": "object"
},
"HealthCheck": {
"description": "Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Only applicable for instances in App Engine flexible environment.",
"id": "HealthCheck",
@@ -2838,6 +2863,20 @@
},
"type": "array"
},
"instanceIpMode": {
"description": "The IP mode for instances. Only applicable in the App Engine flexible environment.",
"enum": [
"INSTANCE_IP_MODE_UNSPECIFIED",
"EXTERNAL",
"INTERNAL"
],
"enumDescriptions": [
"Unspecified should be treated as EXTERNAL",
"VMs should be created with external and internal IPs",
"VMs should be created with internal IPs only"
],
"type": "string"
},
"instanceTag": {
"description": "Tag to apply to the instance during creation. Only applicable in the App Engine flexible environment.",
"type": "string"
@@ -3215,6 +3254,13 @@
"description": "Relative name of the service within the application. Example: default.@OutputOnly",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "A set of labels to apply to this service. Labels are key/value pairs that describe the service and all resources that belong to it (e.g., versions). The labels can be used to search and group resources, and are propagated to the usage and billing reports, enabling fine-grain analysis of costs. An example of using labels is to tag resources belonging to different environments (e.g., \"env=prod\", \"env=qa\"). Label keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores, dashes, and international characters. Label keys must start with a lowercase letter or an international character. Each service can have at most 32 labels.",
"type": "object"
},
"name": {
"description": "Full path to the Service resource in the API. Example: apps/myapp/services/default.@OutputOnly",
"type": "string"
@@ -3739,6 +3785,20 @@
"description": "VPC access connector specification.",
"id": "VpcAccessConnector",
"properties": {
"egressSetting": {
"description": "The egress setting for the connector, controlling what traffic is diverted through it.",
"enum": [
"EGRESS_SETTING_UNSPECIFIED",
"ALL_TRAFFIC",
"PRIVATE_IP_RANGES"
],
"enumDescriptions": [
"",
"Force the use of VPC Access for all egress traffic from the function.",
"Use the VPC Access Connector for private IP space from RFC1918."
],
"type": "string"
},
"name": {
"description": "Full Serverless VPC Access Connector name e.g. /projects/my-project/locations/us-central1/connectors/c1.",
"type": "string"

67
etc/api/area120tables/v1alpha1/area120tables-api.json
View File

@@ -12,10 +12,10 @@
"description": "See and download all your Google Drive files"
},
"https://www.googleapis.com/auth/spreadsheets": {
"description": "See, edit, create, and delete your spreadsheets in Google Drive"
"description": "See, edit, create, and delete all your Google Sheets spreadsheets"
},
"https://www.googleapis.com/auth/spreadsheets.readonly": {
"description": "View your Google Spreadsheets"
"description": "See all your Google Sheets spreadsheets"
},
"https://www.googleapis.com/auth/tables": {
"description": "See, edit, create, and delete your tables in Tables by Area 120"
@@ -159,6 +159,11 @@
"id": "area120tables.tables.list",
"parameterOrder": [],
"parameters": {
"orderBy": {
"description": "Optional. Sorting order for the list of tables on createTime/updateTime.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "The maximum number of tables to return. The service may return fewer than this value. If unspecified, at most 20 tables are returned. The maximum value is 100; values above 100 are coerced to 100.",
"format": "int32",
@@ -410,6 +415,11 @@
"location": "query",
"type": "string"
},
"orderBy": {
"description": "Optional. Sorting order for the list of rows on createTime/updateTime.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "The maximum number of rows to return. The service may return fewer than this value. If unspecified, at most 50 rows are returned. The maximum value is 1,000; values above 1,000 are coerced to 1,000.",
"format": "int32",
@@ -576,7 +586,7 @@
}
}
},
"revision": "20210330",
"revision": "20220301",
"rootUrl": "https://area120tables.googleapis.com/",
"schemas": {
"BatchCreateRowsRequest": {
@@ -657,6 +667,10 @@
"description": "Data type of the column Supported types are auto_id, boolean, boolean_list, creator, create_timestamp, date, dropdown, location, integer, integer_list, number, number_list, person, person_list, tags, check_list, text, text_list, update_timestamp, updater, relationship, file_attachment_list. These types directly map to the column types supported on Tables website.",
"type": "string"
},
"dateDetails": {
"$ref": "DateDetails",
"description": "Optional. Additional details about a date column."
},
"id": {
"description": "Internal id for a column.",
"type": "string"
@@ -672,10 +686,18 @@
"$ref": "LookupDetails",
"description": "Optional. Indicates that this is a lookup column whose value is derived from the relationship column specified in the details. Lookup columns can not be updated directly. To change the value you must update the associated relationship column."
},
"multipleValuesDisallowed": {
"description": "Optional. Indicates whether or not multiple values are allowed for array types where such a restriction is possible.",
"type": "boolean"
},
"name": {
"description": "column name",
"type": "string"
},
"readonly": {
"description": "Optional. Indicates that values for the column cannot be set by the user.",
"type": "boolean"
},
"relationshipDetails": {
"$ref": "RelationshipDetails",
"description": "Optional. Additional details about a relationship column. Specified when data_type is relationship."
@@ -710,6 +732,17 @@
},
"type": "object"
},
"DateDetails": {
"description": "Details about a date column.",
"id": "DateDetails",
"properties": {
"hasTime": {
"description": "Whether the date column includes time.",
"type": "boolean"
}
},
"type": "object"
},
"Empty": {
"description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.",
"id": "Empty",
@@ -839,8 +872,23 @@
},
"type": "object"
},
"SavedView": {
"description": "A saved view of a table. NextId: 3",
"id": "SavedView",
"properties": {
"id": {
"description": "Internal id associated with the saved view.",
"type": "string"
},
"name": {
"description": "Display name of the saved view.",
"type": "string"
}
},
"type": "object"
},
"Table": {
"description": "A single table.",
"description": "A single table. NextId: 8",
"id": "Table",
"properties": {
"columns": {
@@ -863,6 +911,17 @@
"description": "The resource name of the table. Table names have the form `tables/{table}`.",
"type": "string"
},
"savedViews": {
"description": "Saved views for this table.",
"items": {
"$ref": "SavedView"
},
"type": "array"
},
"timeZone": {
"description": "The time zone of the table. IANA Time Zone Database time zone, e.g. \"America/New_York\".",
"type": "string"
},
"updateTime": {
"description": "Time when the table was last updated excluding updates to individual rows",
"format": "google-datetime",

1751
etc/api/artifactregistry/v1/artifactregistry-api.json
View File

File diff suppressed because it is too large Load Diff

140
etc/api/artifactregistry/v1beta1/artifactregistry-api.json
View File

@@ -3,10 +3,10 @@
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "See, edit, configure, and delete your Google Cloud Platform data"
"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
},
"https://www.googleapis.com/auth/cloud-platform.read-only": {
"description": "View your data across Google Cloud Platform services"
"description": "View your data across Google Cloud services and see the email address of your Google Account"
}
}
}
@@ -160,7 +160,7 @@
"type": "string"
},
"pageSize": {
"description": "The maximum number of results to return. If not set, the service will select a default.",
"description": "The maximum number of results to return. If not set, the service selects a default.",
"format": "int32",
"location": "query",
"type": "integer"
@@ -209,48 +209,6 @@
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
]
},
"list": {
"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `\"/v1/{name=users/*}/operations\"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.",
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations",
"httpMethod": "GET",
"id": "artifactregistry.projects.locations.operations.list",
"parameterOrder": [
"name"
],
"parameters": {
"filter": {
"description": "The standard list filter.",
"location": "query",
"type": "string"
},
"name": {
"description": "The name of the operation's parent resource.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"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": "v1beta1/{+name}/operations",
"response": {
"$ref": "ListOperationsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
]
}
}
},
@@ -266,7 +224,7 @@
],
"parameters": {
"parent": {
"description": "The name of the parent resource where the repository will be created.",
"description": "Required. The name of the parent resource where the repository will be created.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
@@ -299,7 +257,7 @@
],
"parameters": {
"name": {
"description": "The name of the repository to delete.",
"description": "Required. The name of the repository to delete.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+$",
"required": true,
@@ -324,7 +282,7 @@
],
"parameters": {
"name": {
"description": "The name of the repository to retrieve.",
"description": "Required. The name of the repository to retrieve.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+$",
"required": true,
@@ -350,7 +308,7 @@
],
"parameters": {
"options.requestedPolicyVersion": {
"description": "Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
"format": "int32",
"location": "query",
"type": "integer"
@@ -382,7 +340,7 @@
],
"parameters": {
"pageSize": {
"description": "The maximum number of repositories to return.",
"description": "The maximum number of repositories to return. Maximum page size is 1,000.",
"format": "int32",
"location": "query",
"type": "integer"
@@ -393,7 +351,7 @@
"type": "string"
},
"parent": {
"description": "The name of the parent resource whose repositories will be listed.",
"description": "Required. The name of the parent resource whose repositories will be listed.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
@@ -586,7 +544,7 @@
],
"parameters": {
"name": {
"description": "The name of the package to delete.",
"description": "Required. The name of the package to delete.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/packages/[^/]+$",
"required": true,
@@ -611,7 +569,7 @@
],
"parameters": {
"name": {
"description": "The name of the package to retrieve.",
"description": "Required. The name of the package to retrieve.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/packages/[^/]+$",
"required": true,
@@ -637,7 +595,7 @@
],
"parameters": {
"pageSize": {
"description": "The maximum number of packages to return.",
"description": "The maximum number of packages to return. Maximum page size is 1,000.",
"format": "int32",
"location": "query",
"type": "integer"
@@ -648,7 +606,7 @@
"type": "string"
},
"parent": {
"description": "The name of the parent resource whose packages will be listed.",
"description": "Required. The name of the parent resource whose packages will be listed.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+$",
"required": true,
@@ -767,7 +725,7 @@
"type": "string"
},
"pageSize": {
"description": "The maximum number of tags to return.",
"description": "The maximum number of tags to return. Maximum page size is 10,000.",
"format": "int32",
"location": "query",
"type": "integer"
@@ -804,7 +762,7 @@
],
"parameters": {
"name": {
"description": "The name of the tag, for example: \"projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/tags/tag1\".",
"description": "The name of the tag, for example: \"projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/tags/tag1\". If the package part contains slashes, the slashes are escaped. The tag part can only have characters in [a-zA-Z0-9\\-._~:@], anything else must be URL encoded.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/packages/[^/]+/tags/[^/]+$",
"required": true,
@@ -913,12 +871,12 @@
],
"parameters": {
"orderBy": {
"description": "Optional. Sorting field and order",
"description": "Optional. The field to order the results by.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "The maximum number of versions to return.",
"description": "The maximum number of versions to return. Maximum page size is 1,000.",
"format": "int32",
"location": "query",
"type": "integer"
@@ -971,26 +929,26 @@
}
}
},
"revision": "20210324",
"revision": "20220225",
"rootUrl": "https://artifactregistry.googleapis.com/",
"schemas": {
"Binding": {
"description": "Associates `members` with a `role`.",
"description": "Associates `members`, or principals, with a `role`.",
"id": "Binding",
"properties": {
"condition": {
"$ref": "Expr",
"description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)."
"description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)."
},
"members": {
"description": "Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ",
"description": "Specifies the principals requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ",
"items": {
"type": "string"
},
"type": "array"
},
"role": {
"description": "Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.",
"description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.",
"type": "string"
}
},
@@ -1042,7 +1000,7 @@
"type": "array"
},
"name": {
"description": "The name of the file, for example: \"projects/p1/locations/us-central1/repositories/repo1/files/a/b/c.txt\".",
"description": "The name of the file, for example: \"projects/p1/locations/us-central1/repositories/repo1/files/a%2Fb%2Fc.txt\". If the file ID part contains slashes, they are escaped.",
"type": "string"
},
"owner": {
@@ -1070,11 +1028,13 @@
"description": "The algorithm used to compute the hash value.",
"enum": [
"HASH_TYPE_UNSPECIFIED",
"SHA256"
"SHA256",
"MD5"
],
"enumDescriptions": [
"Unspecified.",
"SHA256 hash."
"SHA256 hash.",
"MD5 hash."
],
"type": "string"
},
@@ -1122,24 +1082,6 @@
},
"type": "object"
},
"ListOperationsResponse": {
"description": "The response message for Operations.ListOperations.",
"id": "ListOperationsResponse",
"properties": {
"nextPageToken": {
"description": "The standard List next-page token.",
"type": "string"
},
"operations": {
"description": "A list of operations that matches the specified filter in the request.",
"items": {
"$ref": "Operation"
},
"type": "array"
}
},
"type": "object"
},
"ListPackagesResponse": {
"description": "The response from listing packages.",
"id": "ListPackagesResponse",
@@ -1295,7 +1237,7 @@
"type": "string"
},
"name": {
"description": "The name of the package, for example: \"projects/p1/locations/us-central1/repositories/repo1/packages/pkg1\".",
"description": "The name of the package, for example: \"projects/p1/locations/us-central1/repositories/repo1/packages/pkg1\". If the package ID part contains slashes, the slashes are escaped.",
"type": "string"
},
"updateTime": {
@@ -1307,11 +1249,11 @@
"type": "object"
},
"Policy": {
"description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).",
"description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).",
"id": "Policy",
"properties": {
"bindings": {
"description": "Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.",
"description": "Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.",
"items": {
"$ref": "Binding"
},
@@ -1347,16 +1289,26 @@
"description": "The format of packages that are stored in the repository.",
"enum": [
"FORMAT_UNSPECIFIED",
"DOCKER"
"DOCKER",
"MAVEN",
"NPM",
"APT",
"YUM",
"PYTHON"
],
"enumDescriptions": [
"Unspecified package format.",
"Docker package format."
"Docker package format.",
"Maven package format.",
"NPM package format.",
"APT package format.",
"YUM package format.",
"Python package format."
],
"type": "string"
},
"kmsKeyName": {
"description": "The Cloud KMS resource name of the customer managed encryption key that\u2019s used to encrypt the contents of the Repository. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. This value may not be changed after the Repository has been created.",
"description": "The Cloud KMS resource name of the customer managed encryption key that's used to encrypt the contents of the Repository. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. This value may not be changed after the Repository has been created.",
"type": "string"
},
"labels": {
@@ -1421,11 +1373,11 @@
"id": "Tag",
"properties": {
"name": {
"description": "The name of the tag, for example: \"projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/tags/tag1\".",
"description": "The name of the tag, for example: \"projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/tags/tag1\". If the package part contains slashes, the slashes are escaped. The tag part can only have characters in [a-zA-Z0-9\\-._~:@], anything else must be URL encoded.",
"type": "string"
},
"version": {
"description": "The name of the version the tag refers to, for example: \"projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/sha256:5243811\"",
"description": "The name of the version the tag refers to, for example: \"projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/sha256:5243811\" If the package or version ID parts contain slashes, the slashes are escaped.",
"type": "string"
}
},
@@ -1473,7 +1425,7 @@
"type": "string"
},
"name": {
"description": "The name of the version, for example: \"projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/art1\".",
"description": "The name of the version, for example: \"projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/art1\". If the package or version ID parts contain slashes, the slashes are escaped.",
"type": "string"
},
"relatedTags": {

700
etc/api/artifactregistry/v1beta2/artifactregistry-api.json
View File

@@ -3,10 +3,10 @@
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "See, edit, configure, and delete your Google Cloud Platform data"
"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
},
"https://www.googleapis.com/auth/cloud-platform.read-only": {
"description": "View your data across Google Cloud Platform services"
"description": "View your data across Google Cloud services and see the email address of your Google Account"
}
}
}
@@ -109,6 +109,68 @@
"protocol": "rest",
"resources": {
"projects": {
"methods": {
"getProjectSettings": {
"description": "Retrieves the Settings for the Project.",
"flatPath": "v1beta2/projects/{projectsId}/projectSettings",
"httpMethod": "GET",
"id": "artifactregistry.projects.getProjectSettings",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the projectSettings resource.",
"location": "path",
"pattern": "^projects/[^/]+/projectSettings$",
"required": true,
"type": "string"
}
},
"path": "v1beta2/{+name}",
"response": {
"$ref": "ProjectSettings"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
]
},
"updateProjectSettings": {
"description": "Updates the Settings for the Project.",
"flatPath": "v1beta2/projects/{projectsId}/projectSettings",
"httpMethod": "PATCH",
"id": "artifactregistry.projects.updateProjectSettings",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the project's settings. Always of the form: projects/{project-id}/projectSettings In update request: never set In response: always set",
"location": "path",
"pattern": "^projects/[^/]+/projectSettings$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Field mask to support partial updates.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1beta2/{+name}",
"request": {
"$ref": "ProjectSettings"
},
"response": {
"$ref": "ProjectSettings"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
},
"resources": {
"locations": {
"methods": {
@@ -160,7 +222,7 @@
"type": "string"
},
"pageSize": {
"description": "The maximum number of results to return. If not set, the service will select a default.",
"description": "The maximum number of results to return. If not set, the service selects a default.",
"format": "int32",
"location": "query",
"type": "integer"
@@ -209,48 +271,6 @@
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
]
},
"list": {
"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `\"/v1/{name=users/*}/operations\"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.",
"flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/operations",
"httpMethod": "GET",
"id": "artifactregistry.projects.locations.operations.list",
"parameterOrder": [
"name"
],
"parameters": {
"filter": {
"description": "The standard list filter.",
"location": "query",
"type": "string"
},
"name": {
"description": "The name of the operation's parent resource.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"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": "v1beta2/{+name}/operations",
"response": {
"$ref": "ListOperationsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
]
}
}
},
@@ -266,7 +286,7 @@
],
"parameters": {
"parent": {
"description": "The name of the parent resource where the repository will be created.",
"description": "Required. The name of the parent resource where the repository will be created.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
@@ -299,7 +319,7 @@
],
"parameters": {
"name": {
"description": "The name of the repository to delete.",
"description": "Required. The name of the repository to delete.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+$",
"required": true,
@@ -324,7 +344,7 @@
],
"parameters": {
"name": {
"description": "The name of the repository to retrieve.",
"description": "Required. The name of the repository to retrieve.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+$",
"required": true,
@@ -350,7 +370,7 @@
],
"parameters": {
"options.requestedPolicyVersion": {
"description": "Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
"format": "int32",
"location": "query",
"type": "integer"
@@ -382,7 +402,7 @@
],
"parameters": {
"pageSize": {
"description": "The maximum number of repositories to return. Maximum page size is 10,000.",
"description": "The maximum number of repositories to return. Maximum page size is 1,000.",
"format": "int32",
"location": "query",
"type": "integer"
@@ -393,7 +413,7 @@
"type": "string"
},
"parent": {
"description": "The name of the parent resource whose repositories will be listed.",
"description": "Required. The name of the parent resource whose repositories will be listed.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
@@ -502,6 +522,78 @@
}
},
"resources": {
"aptArtifacts": {
"methods": {
"import": {
"description": "Imports Apt artifacts. The returned Operation will complete once the resources are imported. Package, Version, and File resources are created based on the imported artifacts. Imported artifacts that conflict with existing resources are ignored.",
"flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/aptArtifacts:import",
"httpMethod": "POST",
"id": "artifactregistry.projects.locations.repositories.aptArtifacts.import",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "The name of the parent resource where the artifacts will be imported.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta2/{+parent}/aptArtifacts:import",
"request": {
"$ref": "ImportAptArtifactsRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"upload": {
"description": "Directly uploads an Apt artifact. The returned Operation will complete once the resources are uploaded. Package, Version, and File resources are created based on the imported artifact. Imported artifacts that conflict with existing resources are ignored.",
"flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/aptArtifacts:create",
"httpMethod": "POST",
"id": "artifactregistry.projects.locations.repositories.aptArtifacts.upload",
"mediaUpload": {
"accept": [
"*/*"
],
"protocols": {
"simple": {
"multipart": true,
"path": "/upload/v1beta2/{+parent}/aptArtifacts:create"
}
}
},
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "The name of the parent resource where the artifacts will be uploaded.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta2/{+parent}/aptArtifacts:create",
"request": {
"$ref": "UploadAptArtifactRequest"
},
"response": {
"$ref": "UploadAptArtifactMediaResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"supportsMediaUpload": true
}
}
},
"files": {
"methods": {
"get": {
@@ -523,7 +615,7 @@
},
"path": "v1beta2/{+name}",
"response": {
"$ref": "File"
"$ref": "GoogleDevtoolsArtifactregistryV1beta2File"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
@@ -586,7 +678,7 @@
],
"parameters": {
"name": {
"description": "The name of the package to delete.",
"description": "Required. The name of the package to delete.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/packages/[^/]+$",
"required": true,
@@ -611,7 +703,7 @@
],
"parameters": {
"name": {
"description": "The name of the package to retrieve.",
"description": "Required. The name of the package to retrieve.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/packages/[^/]+$",
"required": true,
@@ -637,7 +729,7 @@
],
"parameters": {
"pageSize": {
"description": "The maximum number of packages to return. Maximum page size is 10,000.",
"description": "The maximum number of packages to return. Maximum page size is 1,000.",
"format": "int32",
"location": "query",
"type": "integer"
@@ -648,7 +740,7 @@
"type": "string"
},
"parent": {
"description": "The name of the parent resource whose packages will be listed.",
"description": "Required. The name of the parent resource whose packages will be listed.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+$",
"required": true,
@@ -804,7 +896,7 @@
],
"parameters": {
"name": {
"description": "The name of the tag, for example: \"projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/tags/tag1\".",
"description": "The name of the tag, for example: \"projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/tags/tag1\". If the package part contains slashes, the slashes are escaped. The tag part can only have characters in [a-zA-Z0-9\\-._~:@], anything else must be URL encoded.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/packages/[^/]+/tags/[^/]+$",
"required": true,
@@ -913,12 +1005,12 @@
],
"parameters": {
"orderBy": {
"description": "Optional. Sorting field and order",
"description": "Optional. The field to order the results by.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "The maximum number of versions to return. Maximum page size is 10,000.",
"description": "The maximum number of versions to return. Maximum page size is 1,000.",
"format": "int32",
"location": "query",
"type": "integer"
@@ -963,6 +1055,78 @@
}
}
}
},
"yumArtifacts": {
"methods": {
"import": {
"description": "Imports Yum (RPM) artifacts. The returned Operation will complete once the resources are imported. Package, Version, and File resources are created based on the imported artifacts. Imported artifacts that conflict with existing resources are ignored.",
"flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/yumArtifacts:import",
"httpMethod": "POST",
"id": "artifactregistry.projects.locations.repositories.yumArtifacts.import",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "The name of the parent resource where the artifacts will be imported.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta2/{+parent}/yumArtifacts:import",
"request": {
"$ref": "ImportYumArtifactsRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"upload": {
"description": "Directly uploads a Yum artifact. The returned Operation will complete once the resources are uploaded. Package, Version, and File resources are created based on the imported artifact. Imported artifacts that conflict with existing resources are ignored.",
"flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/yumArtifacts:create",
"httpMethod": "POST",
"id": "artifactregistry.projects.locations.repositories.yumArtifacts.upload",
"mediaUpload": {
"accept": [
"*/*"
],
"protocols": {
"simple": {
"multipart": true,
"path": "/upload/v1beta2/{+parent}/yumArtifacts:create"
}
}
},
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "The name of the parent resource where the artifacts will be uploaded.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta2/{+parent}/yumArtifacts:create",
"request": {
"$ref": "UploadYumArtifactRequest"
},
"response": {
"$ref": "UploadYumArtifactMediaResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"supportsMediaUpload": true
}
}
}
}
}
@@ -971,26 +1135,74 @@
}
}
},
"revision": "20210324",
"revision": "20220225",
"rootUrl": "https://artifactregistry.googleapis.com/",
"schemas": {
"AptArtifact": {
"description": "A detailed representation of an Apt artifact. Information in the record is derived from the archive's control file. See https://www.debian.org/doc/debian-policy/ch-controlfields.html",
"id": "AptArtifact",
"properties": {
"architecture": {
"description": "Output only. Operating system architecture of the artifact.",
"readOnly": true,
"type": "string"
},
"component": {
"description": "Output only. Repository component of the artifact.",
"readOnly": true,
"type": "string"
},
"controlFile": {
"description": "Output only. Contents of the artifact's control metadata file.",
"format": "byte",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Output only. The Artifact Registry resource name of the artifact.",
"readOnly": true,
"type": "string"
},
"packageName": {
"description": "Output only. The Apt package name of the artifact.",
"readOnly": true,
"type": "string"
},
"packageType": {
"description": "Output only. An artifact is a binary or source package.",
"enum": [
"PACKAGE_TYPE_UNSPECIFIED",
"BINARY",
"SOURCE"
],
"enumDescriptions": [
"Package type is not specified.",
"Binary package.",
"Source package."
],
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"Binding": {
"description": "Associates `members` with a `role`.",
"description": "Associates `members`, or principals, with a `role`.",
"id": "Binding",
"properties": {
"condition": {
"$ref": "Expr",
"description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)."
"description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)."
},
"members": {
"description": "Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ",
"description": "Specifies the principals requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ",
"items": {
"type": "string"
},
"type": "array"
},
"role": {
"description": "Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.",
"description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.",
"type": "string"
}
},
@@ -1025,9 +1237,9 @@
},
"type": "object"
},
"File": {
"GoogleDevtoolsArtifactregistryV1beta2File": {
"description": "Files store content that is potentially associated with Packages or Versions.",
"id": "File",
"id": "GoogleDevtoolsArtifactregistryV1beta2File",
"properties": {
"createTime": {
"description": "The time when the File was created.",
@@ -1042,7 +1254,7 @@
"type": "array"
},
"name": {
"description": "The name of the file, for example: \"projects/p1/locations/us-central1/repositories/repo1/files/a/b/c.txt\".",
"description": "The name of the file, for example: \"projects/p1/locations/us-central1/repositories/repo1/files/a%2Fb%2Fc.txt\". If the file ID part contains slashes, they are escaped.",
"type": "string"
},
"owner": {
@@ -1070,11 +1282,13 @@
"description": "The algorithm used to compute the hash value.",
"enum": [
"HASH_TYPE_UNSPECIFIED",
"SHA256"
"SHA256",
"MD5"
],
"enumDescriptions": [
"Unspecified.",
"SHA256 hash."
"SHA256 hash.",
"MD5 hash."
],
"type": "string"
},
@@ -1086,6 +1300,136 @@
},
"type": "object"
},
"ImportAptArtifactsErrorInfo": {
"description": "Error information explaining why a package was not imported.",
"id": "ImportAptArtifactsErrorInfo",
"properties": {
"error": {
"$ref": "Status",
"description": "The detailed error status."
},
"gcsSource": {
"$ref": "ImportAptArtifactsGcsSource",
"description": "Google Cloud Storage location requested."
}
},
"type": "object"
},
"ImportAptArtifactsGcsSource": {
"description": "Google Cloud Storage location where the artifacts currently reside.",
"id": "ImportAptArtifactsGcsSource",
"properties": {
"uris": {
"description": "Cloud Storage paths URI (e.g., gs://my_bucket//my_object).",
"items": {
"type": "string"
},
"type": "array"
},
"useWildcards": {
"description": "Supports URI wildcards for matching multiple objects from a single URI.",
"type": "boolean"
}
},
"type": "object"
},
"ImportAptArtifactsRequest": {
"description": "The request to import new apt artifacts.",
"id": "ImportAptArtifactsRequest",
"properties": {
"gcsSource": {
"$ref": "ImportAptArtifactsGcsSource",
"description": "Google Cloud Storage location where input content is located."
}
},
"type": "object"
},
"ImportAptArtifactsResponse": {
"description": "The response message from importing APT artifacts.",
"id": "ImportAptArtifactsResponse",
"properties": {
"aptArtifacts": {
"description": "The Apt artifacts imported.",
"items": {
"$ref": "AptArtifact"
},
"type": "array"
},
"errors": {
"description": "Detailed error info for packages that were not imported.",
"items": {
"$ref": "ImportAptArtifactsErrorInfo"
},
"type": "array"
}
},
"type": "object"
},
"ImportYumArtifactsErrorInfo": {
"description": "Error information explaining why a package was not imported.",
"id": "ImportYumArtifactsErrorInfo",
"properties": {
"error": {
"$ref": "Status",
"description": "The detailed error status."
},
"gcsSource": {
"$ref": "ImportYumArtifactsGcsSource",
"description": "Google Cloud Storage location requested."
}
},
"type": "object"
},
"ImportYumArtifactsGcsSource": {
"description": "Google Cloud Storage location where the artifacts currently reside.",
"id": "ImportYumArtifactsGcsSource",
"properties": {
"uris": {
"description": "Cloud Storage paths URI (e.g., gs://my_bucket//my_object).",
"items": {
"type": "string"
},
"type": "array"
},
"useWildcards": {
"description": "Supports URI wildcards for matching multiple objects from a single URI.",
"type": "boolean"
}
},
"type": "object"
},
"ImportYumArtifactsRequest": {
"description": "The request to import new yum artifacts.",
"id": "ImportYumArtifactsRequest",
"properties": {
"gcsSource": {
"$ref": "ImportYumArtifactsGcsSource",
"description": "Google Cloud Storage location where input content is located."
}
},
"type": "object"
},
"ImportYumArtifactsResponse": {
"description": "The response message from importing YUM artifacts.",
"id": "ImportYumArtifactsResponse",
"properties": {
"errors": {
"description": "Detailed error info for packages that were not imported.",
"items": {
"$ref": "ImportYumArtifactsErrorInfo"
},
"type": "array"
},
"yumArtifacts": {
"description": "The yum artifacts imported.",
"items": {
"$ref": "YumArtifact"
},
"type": "array"
}
},
"type": "object"
},
"ListFilesResponse": {
"description": "The response from listing files.",
"id": "ListFilesResponse",
@@ -1093,7 +1437,7 @@
"files": {
"description": "The files returned.",
"items": {
"$ref": "File"
"$ref": "GoogleDevtoolsArtifactregistryV1beta2File"
},
"type": "array"
},
@@ -1122,24 +1466,6 @@
},
"type": "object"
},
"ListOperationsResponse": {
"description": "The response message for Operations.ListOperations.",
"id": "ListOperationsResponse",
"properties": {
"nextPageToken": {
"description": "The standard List next-page token.",
"type": "string"
},
"operations": {
"description": "A list of operations that matches the specified filter in the request.",
"items": {
"$ref": "Operation"
},
"type": "array"
}
},
"type": "object"
},
"ListPackagesResponse": {
"description": "The response from listing packages.",
"id": "ListPackagesResponse",
@@ -1246,6 +1572,31 @@
},
"type": "object"
},
"MavenRepositoryConfig": {
"description": "MavenRepositoryConfig is maven related repository details. Provides additional configuration details for repositories of the maven format type.",
"id": "MavenRepositoryConfig",
"properties": {
"allowSnapshotOverwrites": {
"description": "The repository with this flag will allow publishing the same snapshot versions.",
"type": "boolean"
},
"versionPolicy": {
"description": "Version policy defines the versions that the registry will accept.",
"enum": [
"VERSION_POLICY_UNSPECIFIED",
"RELEASE",
"SNAPSHOT"
],
"enumDescriptions": [
"VERSION_POLICY_UNSPECIFIED - the version policy is not defined. When the version policy is not defined, no validation is performed for the versions.",
"RELEASE - repository will accept only Release versions.",
"SNAPSHOT - repository will accept only Snapshot versions."
],
"type": "string"
}
},
"type": "object"
},
"Operation": {
"description": "This resource represents a long-running operation that is the result of a network API call.",
"id": "Operation",
@@ -1281,6 +1632,12 @@
},
"type": "object"
},
"OperationMetadata": {
"description": "Metadata type for longrunning-operations, currently empty.",
"id": "OperationMetadata",
"properties": {},
"type": "object"
},
"Package": {
"description": "Packages are named collections of versions.",
"id": "Package",
@@ -1295,7 +1652,7 @@
"type": "string"
},
"name": {
"description": "The name of the package, for example: \"projects/p1/locations/us-central1/repositories/repo1/packages/pkg1\".",
"description": "The name of the package, for example: \"projects/p1/locations/us-central1/repositories/repo1/packages/pkg1\". If the package ID part contains slashes, the slashes are escaped.",
"type": "string"
},
"updateTime": {
@@ -1307,11 +1664,11 @@
"type": "object"
},
"Policy": {
"description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).",
"description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).",
"id": "Policy",
"properties": {
"bindings": {
"description": "Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.",
"description": "Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.",
"items": {
"$ref": "Binding"
},
@@ -1330,6 +1687,33 @@
},
"type": "object"
},
"ProjectSettings": {
"description": "The Artifact Registry settings that apply to a Project.",
"id": "ProjectSettings",
"properties": {
"legacyRedirectionState": {
"description": "The redirection state of the legacy repositories in this project.",
"enum": [
"REDIRECTION_STATE_UNSPECIFIED",
"REDIRECTION_FROM_GCR_IO_DISABLED",
"REDIRECTION_FROM_GCR_IO_ENABLED",
"REDIRECTION_FROM_GCR_IO_FINALIZED"
],
"enumDescriptions": [
"No redirection status has been set.",
"Redirection is disabled.",
"Redirection is enabled.",
"Redirection is enabled, and has been finalized so cannot be reverted."
],
"type": "string"
},
"name": {
"description": "The name of the project's settings. Always of the form: projects/{project-id}/projectSettings In update request: never set In response: always set",
"type": "string"
}
},
"type": "object"
},
"Repository": {
"description": "A Repository for storing artifacts with a specific format.",
"id": "Repository",
@@ -1347,16 +1731,26 @@
"description": "The format of packages that are stored in the repository.",
"enum": [
"FORMAT_UNSPECIFIED",
"DOCKER"
"DOCKER",
"MAVEN",
"NPM",
"APT",
"YUM",
"PYTHON"
],
"enumDescriptions": [
"Unspecified package format.",
"Docker package format."
"Docker package format.",
"Maven package format.",
"NPM package format.",
"APT package format.",
"YUM package format.",
"Python package format."
],
"type": "string"
},
"kmsKeyName": {
"description": "The Cloud KMS resource name of the customer managed encryption key that\u2019s used to encrypt the contents of the Repository. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. This value may not be changed after the Repository has been created.",
"description": "The Cloud KMS resource name of the customer managed encryption key that's used to encrypt the contents of the Repository. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. This value may not be changed after the Repository has been created.",
"type": "string"
},
"labels": {
@@ -1366,6 +1760,10 @@
"description": "Labels with user-defined metadata. This field may contain up to 64 entries. Label keys and values may be no longer than 63 characters. Label keys must begin with a lowercase letter and may only contain lowercase letters, numeric characters, underscores, and dashes.",
"type": "object"
},
"mavenConfig": {
"$ref": "MavenRepositoryConfig",
"description": "Maven repository config contains repository level configuration for the repositories of maven type."
},
"name": {
"description": "The name of the repository, for example: \"projects/p1/locations/us-central1/repositories/repo1\".",
"type": "string"
@@ -1421,11 +1819,11 @@
"id": "Tag",
"properties": {
"name": {
"description": "The name of the tag, for example: \"projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/tags/tag1\".",
"description": "The name of the tag, for example: \"projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/tags/tag1\". If the package part contains slashes, the slashes are escaped. The tag part can only have characters in [a-zA-Z0-9\\-._~:@], anything else must be URL encoded.",
"type": "string"
},
"version": {
"description": "The name of the version the tag refers to, for example: \"projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/sha256:5243811\"",
"description": "The name of the version the tag refers to, for example: \"projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/sha256:5243811\" If the package or version ID parts contain slashes, the slashes are escaped.",
"type": "string"
}
},
@@ -1459,6 +1857,68 @@
},
"type": "object"
},
"UploadAptArtifactMediaResponse": {
"description": "The response to upload an artifact.",
"id": "UploadAptArtifactMediaResponse",
"properties": {
"operation": {
"$ref": "Operation",
"description": "Operation to be returned to the user."
}
},
"type": "object"
},
"UploadAptArtifactRequest": {
"description": "The request to upload an artifact.",
"id": "UploadAptArtifactRequest",
"properties": {},
"type": "object"
},
"UploadAptArtifactResponse": {
"description": "The response of the completed artifact upload operation. This response is contained in the Operation and available to users.",
"id": "UploadAptArtifactResponse",
"properties": {
"aptArtifacts": {
"description": "The Apt artifacts updated.",
"items": {
"$ref": "AptArtifact"
},
"type": "array"
}
},
"type": "object"
},
"UploadYumArtifactMediaResponse": {
"description": "The response to upload an artifact.",
"id": "UploadYumArtifactMediaResponse",
"properties": {
"operation": {
"$ref": "Operation",
"description": "Operation to be returned to the user."
}
},
"type": "object"
},
"UploadYumArtifactRequest": {
"description": "The request to upload an artifact.",
"id": "UploadYumArtifactRequest",
"properties": {},
"type": "object"
},
"UploadYumArtifactResponse": {
"description": "The response of the completed artifact upload operation. This response is contained in the Operation and available to users.",
"id": "UploadYumArtifactResponse",
"properties": {
"yumArtifacts": {
"description": "The Apt artifacts updated.",
"items": {
"$ref": "YumArtifact"
},
"type": "array"
}
},
"type": "object"
},
"Version": {
"description": "The body of a version resource. A version resource represents a collection of components, such as files and other data. This may correspond to a version in many package management schemes.",
"id": "Version",
@@ -1472,8 +1932,17 @@
"description": "Optional. Description of the version, as specified in its metadata.",
"type": "string"
},
"metadata": {
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "Output only. Repository-specific Metadata stored against this version. The fields returned are defined by the underlying repository-specific resource. Currently, the only resource in use is DockerImage",
"readOnly": true,
"type": "object"
},
"name": {
"description": "The name of the version, for example: \"projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/art1\".",
"description": "The name of the version, for example: \"projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/art1\". If the package or version ID parts contain slashes, the slashes are escaped.",
"type": "string"
},
"relatedTags": {
@@ -1490,6 +1959,43 @@
}
},
"type": "object"
},
"YumArtifact": {
"description": "A detailed representation of a Yum artifact.",
"id": "YumArtifact",
"properties": {
"architecture": {
"description": "Output only. Operating system architecture of the artifact.",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Output only. The Artifact Registry resource name of the artifact.",
"readOnly": true,
"type": "string"
},
"packageName": {
"description": "Output only. The yum package name of the artifact.",
"readOnly": true,
"type": "string"
},
"packageType": {
"description": "Output only. An artifact is a binary or source package.",
"enum": [
"PACKAGE_TYPE_UNSPECIFIED",
"BINARY",
"SOURCE"
],
"enumDescriptions": [
"Package type is not specified.",
"Binary package (.rpm).",
"Source package (.srpm)."
],
"readOnly": true,
"type": "string"
}
},
"type": "object"
}
},
"servicePath": "",

635
etc/api/assuredworkloads/v1/assuredworkloads-api.json
View File

@@ -3,7 +3,7 @@
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "See, edit, configure, and delete your Google Cloud Platform data"
"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
}
}
}
@@ -351,7 +351,7 @@
}
}
},
"revision": "20210325",
"revision": "20220224",
"rootUrl": "https://assuredworkloads.googleapis.com/",
"schemas": {
"GoogleCloudAssuredworkloadsV1CreateWorkloadOperationMetadata": {
@@ -366,7 +366,11 @@
"CJIS",
"FEDRAMP_HIGH",
"FEDRAMP_MODERATE",
"US_REGIONAL_ACCESS"
"US_REGIONAL_ACCESS",
"HIPAA",
"HITRUST",
"EU_REGIONS_AND_SUPPORT",
"CA_REGIONS_AND_SUPPORT"
],
"enumDescriptions": [
"Unknown compliance regime.",
@@ -374,7 +378,11 @@
"Criminal Justice Information Services (CJIS) Security policies.",
"FedRAMP High data protection controls",
"FedRAMP Moderate data protection controls",
"Assured Workloads For US Regions data protection controls"
"Assured Workloads For US Regions data protection controls",
"Health Insurance Portability and Accountability Act controls",
"Health Information Trust Alliance controls",
"Assured Workloads For EU Regions and Support controls",
"Assured Workloads For Canada Regions and Support controls"
],
"type": "string"
},
@@ -417,7 +425,7 @@
"id": "GoogleCloudAssuredworkloadsV1Workload",
"properties": {
"billingAccount": {
"description": "Required. Input only. The billing account used for the resources which are direct children of workload. This billing account is initially associated with the resources created as part of Workload creation. After the initial creation of these resources, the customer can change the assigned billing account. The resource name has the form `billingAccounts/{billing_account_id}`. For example, `billingAccounts/012345-567890-ABCDEF`.",
"description": "Optional. The billing account used for the resources which are direct children of workload. This billing account is initially associated with the resources created as part of Workload creation. After the initial creation of these resources, the customer can change the assigned billing account. The resource name has the form `billingAccounts/{billing_account_id}`. For example, `billingAccounts/012345-567890-ABCDEF`.",
"type": "string"
},
"complianceRegime": {
@@ -428,7 +436,11 @@
"CJIS",
"FEDRAMP_HIGH",
"FEDRAMP_MODERATE",
"US_REGIONAL_ACCESS"
"US_REGIONAL_ACCESS",
"HIPAA",
"HITRUST",
"EU_REGIONS_AND_SUPPORT",
"CA_REGIONS_AND_SUPPORT"
],
"enumDescriptions": [
"Unknown compliance regime.",
@@ -436,7 +448,11 @@
"Criminal Justice Information Services (CJIS) Security policies.",
"FedRAMP High data protection controls",
"FedRAMP Moderate data protection controls",
"Assured Workloads For US Regions data protection controls"
"Assured Workloads For US Regions data protection controls",
"Health Insurance Portability and Accountability Act controls",
"Health Information Trust Alliance controls",
"Assured Workloads For EU Regions and Support controls",
"Assured Workloads For Canada Regions and Support controls"
],
"type": "string"
},
@@ -450,13 +466,32 @@
"description": "Required. The user-assigned display name of the Workload. When present it must be between 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, and spaces. Example: My Workload",
"type": "string"
},
"enableSovereignControls": {
"description": "Optional. Indicates the sovereignty status of the given workload. Currently meant to be used by Europe/Canada customers.",
"type": "boolean"
},
"etag": {
"description": "Optional. ETag of the workload, it is calculated on the basis of the Workload contents. It will be used in Update & Delete operations.",
"type": "string"
},
"kajEnrollmentState": {
"description": "Output only. Represents the KAJ enrollment state of the given workload.",
"enum": [
"KAJ_ENROLLMENT_STATE_UNSPECIFIED",
"KAJ_ENROLLMENT_STATE_PENDING",
"KAJ_ENROLLMENT_STATE_COMPLETE"
],
"enumDescriptions": [
"Default State for KAJ Enrollment.",
"Pending State for KAJ Enrollment.",
"Complete State for KAJ Enrollment."
],
"readOnly": true,
"type": "string"
},
"kmsSettings": {
"$ref": "GoogleCloudAssuredworkloadsV1WorkloadKMSSettings",
"description": "Input only. Settings used to create a CMEK crypto key. When set a project with a KMS CMEK key is provisioned. This field is mandatory for a subset of Compliance Regimes."
"description": "Input only. Settings used to create a CMEK crypto key. When set, a project with a KMS CMEK key is provisioned. This field is deprecated as of Feb 28, 2022. In order to create a Keyring, callers should specify, ENCRYPTION_KEYS_PROJECT or KEYRING in ResourceSettings.resource_type field."
},
"labels": {
"additionalProperties": {
@@ -470,9 +505,16 @@
"type": "string"
},
"provisionedResourcesParent": {
"description": "Input only. The parent resource for the resources managed by this Assured Workload. May be either an organization or a folder. Must be the same or a child of the Workload parent. If not specified all resources are created under the Workload parent. Formats: folders/{folder_id} organizations/{organization_id}",
"description": "Input only. The parent resource for the resources managed by this Assured Workload. May be either empty or a folder resource which is a child of the Workload parent. If not specified all resources are created under the parent organization. Format: folders/{folder_id}",
"type": "string"
},
"resourceSettings": {
"description": "Input only. Resource properties that are used to customize workload resources. These properties (such as custom project id) will be used to create workload resources if possible. This field is optional.",
"items": {
"$ref": "GoogleCloudAssuredworkloadsV1WorkloadResourceSettings"
},
"type": "array"
},
"resources": {
"description": "Output only. The resources associated with this workload. These resources will be created when creating the workload. If any of the projects already exist, the workload creation will fail. Always read only.",
"items": {
@@ -480,6 +522,11 @@
},
"readOnly": true,
"type": "array"
},
"saaEnrollmentResponse": {
"$ref": "GoogleCloudAssuredworkloadsV1WorkloadSaaEnrollmentResponse",
"description": "Output only. Represents the SAA enrollment response of the given workload. SAA enrollment response is queried during GetWorkload call. In failure cases, user friendly error message is shown in SAA details page.",
"readOnly": true
}
},
"type": "object"
@@ -515,12 +562,91 @@
"enum": [
"RESOURCE_TYPE_UNSPECIFIED",
"CONSUMER_PROJECT",
"ENCRYPTION_KEYS_PROJECT"
"CONSUMER_FOLDER",
"ENCRYPTION_KEYS_PROJECT",
"KEYRING"
],
"enumDescriptions": [
"Unknown resource type.",
"Consumer project.",
"Consumer project containing encryption keys."
"Consumer project. AssuredWorkloads Projects are no longer supported. This field will be ignored only in CreateWorkload requests. ListWorkloads and GetWorkload will continue to provide projects information. Use CONSUMER_FOLDER instead.",
"Consumer Folder.",
"Consumer project containing encryption keys.",
"Keyring resource that hosts encryption keys."
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAssuredworkloadsV1WorkloadResourceSettings": {
"description": "Represent the custom settings for the resources to be created.",
"id": "GoogleCloudAssuredworkloadsV1WorkloadResourceSettings",
"properties": {
"displayName": {
"description": "User-assigned resource display name. If not empty it will be used to create a resource with the specified name.",
"type": "string"
},
"resourceId": {
"description": "Resource identifier. For a project this represents project_id. If the project is already taken, the workload creation will fail. For KeyRing, this represents the keyring_id. For a folder, don't set this value as folder_id is assigned by Google.",
"type": "string"
},
"resourceType": {
"description": "Indicates the type of resource. This field should be specified to correspond the id to the right project type (CONSUMER_PROJECT or ENCRYPTION_KEYS_PROJECT)",
"enum": [
"RESOURCE_TYPE_UNSPECIFIED",
"CONSUMER_PROJECT",
"CONSUMER_FOLDER",
"ENCRYPTION_KEYS_PROJECT",
"KEYRING"
],
"enumDescriptions": [
"Unknown resource type.",
"Consumer project. AssuredWorkloads Projects are no longer supported. This field will be ignored only in CreateWorkload requests. ListWorkloads and GetWorkload will continue to provide projects information. Use CONSUMER_FOLDER instead.",
"Consumer Folder.",
"Consumer project containing encryption keys.",
"Keyring resource that hosts encryption keys."
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAssuredworkloadsV1WorkloadSaaEnrollmentResponse": {
"description": "Signed Access Approvals (SAA) enrollment response.",
"id": "GoogleCloudAssuredworkloadsV1WorkloadSaaEnrollmentResponse",
"properties": {
"setupErrors": {
"description": "Indicates SAA enrollment setup error if any.",
"items": {
"enum": [
"SETUP_ERROR_UNSPECIFIED",
"ERROR_INVALID_BASE_SETUP",
"ERROR_MISSING_EXTERNAL_SIGNING_KEY",
"ERROR_NOT_ALL_SERVICES_ENROLLED",
"ERROR_SETUP_CHECK_FAILED"
],
"enumDescriptions": [
"Unspecified.",
"Invalid states for all customers, to be redirected to AA UI for additional details.",
"Returned when there is not an EKM key configured.",
"Returned when there are no enrolled services or the customer is enrolled in CAA only for a subset of services.",
"Returned when exception was encountered during evaluation of other criteria."
],
"type": "string"
},
"type": "array"
},
"setupStatus": {
"description": "Indicates SAA enrollment status of a given workload.",
"enum": [
"SETUP_STATE_UNSPECIFIED",
"STATUS_PENDING",
"STATUS_COMPLETE"
],
"enumDescriptions": [
"Unspecified.",
"SAA enrollment pending.",
"SAA enrollment comopleted."
],
"type": "string"
}
@@ -541,7 +667,9 @@
"FEDRAMP_MODERATE",
"US_REGIONAL_ACCESS",
"HIPAA",
"HITRUST"
"HITRUST",
"EU_REGIONS_AND_SUPPORT",
"CA_REGIONS_AND_SUPPORT"
],
"enumDescriptions": [
"Unknown compliance regime.",
@@ -551,7 +679,9 @@
"FedRAMP Moderate data protection controls",
"Assured Workloads For US Regions data protection controls",
"Health Insurance Portability and Accountability Act controls",
"Health Information Trust Alliance controls"
"Health Information Trust Alliance controls",
"Assured Workloads For EU Regions and Support controls",
"Assured Workloads For Canada Regions and Support controls"
],
"type": "string"
},
@@ -567,6 +697,13 @@
"parent": {
"description": "Optional. The parent of the workload.",
"type": "string"
},
"resourceSettings": {
"description": "Optional. Resource properties in the input that are used for creating/customizing workload resources.",
"items": {
"$ref": "GoogleCloudAssuredworkloadsV1beta1WorkloadResourceSettings"
},
"type": "array"
}
},
"type": "object"
@@ -576,12 +713,12 @@
"id": "GoogleCloudAssuredworkloadsV1beta1Workload",
"properties": {
"billingAccount": {
"description": "Required. Input only. The billing account used for the resources which are direct children of workload. This billing account is initially associated with the resources created as part of Workload creation. After the initial creation of these resources, the customer can change the assigned billing account. The resource name has the form `billingAccounts/{billing_account_id}`. For example, `billingAccounts/012345-567890-ABCDEF`.",
"description": "Input only. The billing account used for the resources which are direct children of workload. This billing account is initially associated with the resources created as part of Workload creation. After the initial creation of these resources, the customer can change the assigned billing account. The resource name has the form `billingAccounts/{billing_account_id}`. For example, `billingAccounts/012345-567890-ABCDEF`.",
"type": "string"
},
"cjisSettings": {
"$ref": "GoogleCloudAssuredworkloadsV1beta1WorkloadCJISSettings",
"description": "Required. Input only. Immutable. Settings specific to resources needed for CJIS."
"description": "Input only. Immutable. Settings specific to resources needed for CJIS."
},
"complianceRegime": {
"description": "Required. Immutable. Compliance Regime associated with this workload.",
@@ -593,7 +730,9 @@
"FEDRAMP_MODERATE",
"US_REGIONAL_ACCESS",
"HIPAA",
"HITRUST"
"HITRUST",
"EU_REGIONS_AND_SUPPORT",
"CA_REGIONS_AND_SUPPORT"
],
"enumDescriptions": [
"Unknown compliance regime.",
@@ -603,7 +742,9 @@
"FedRAMP Moderate data protection controls",
"Assured Workloads For US Regions data protection controls",
"Health Insurance Portability and Accountability Act controls",
"Health Information Trust Alliance controls"
"Health Information Trust Alliance controls",
"Assured Workloads For EU Regions and Support controls",
"Assured Workloads For Canada Regions and Support controls"
],
"type": "string"
},
@@ -617,25 +758,44 @@
"description": "Required. The user-assigned display name of the Workload. When present it must be between 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, and spaces. Example: My Workload",
"type": "string"
},
"enableSovereignControls": {
"description": "Optional. Indicates the sovereignty status of the given workload. Currently meant to be used by Europe/Canada customers.",
"type": "boolean"
},
"etag": {
"description": "Optional. ETag of the workload, it is calculated on the basis of the Workload contents. It will be used in Update & Delete operations.",
"type": "string"
},
"fedrampHighSettings": {
"$ref": "GoogleCloudAssuredworkloadsV1beta1WorkloadFedrampHighSettings",
"description": "Required. Input only. Immutable. Settings specific to resources needed for FedRAMP High."
"description": "Input only. Immutable. Settings specific to resources needed for FedRAMP High."
},
"fedrampModerateSettings": {
"$ref": "GoogleCloudAssuredworkloadsV1beta1WorkloadFedrampModerateSettings",
"description": "Required. Input only. Immutable. Settings specific to resources needed for FedRAMP Moderate."
"description": "Input only. Immutable. Settings specific to resources needed for FedRAMP Moderate."
},
"il4Settings": {
"$ref": "GoogleCloudAssuredworkloadsV1beta1WorkloadIL4Settings",
"description": "Required. Input only. Immutable. Settings specific to resources needed for IL4."
"description": "Input only. Immutable. Settings specific to resources needed for IL4."
},
"kajEnrollmentState": {
"description": "Output only. Represents the KAJ enrollment state of the given workload.",
"enum": [
"KAJ_ENROLLMENT_STATE_UNSPECIFIED",
"KAJ_ENROLLMENT_STATE_PENDING",
"KAJ_ENROLLMENT_STATE_COMPLETE"
],
"enumDescriptions": [
"Default State for KAJ Enrollment.",
"Pending State for KAJ Enrollment.",
"Complete State for KAJ Enrollment."
],
"readOnly": true,
"type": "string"
},
"kmsSettings": {
"$ref": "GoogleCloudAssuredworkloadsV1beta1WorkloadKMSSettings",
"description": "Input only. Settings used to create a CMEK crypto key. When set a project with a KMS CMEK key is provisioned. This field is mandatory for a subset of Compliance Regimes."
"description": "Input only. Settings used to create a CMEK crypto key. When set, a project with a KMS CMEK key is provisioned. This field is deprecated as of Feb 28, 2022. In order to create a Keyring, callers should specify, ENCRYPTION_KEYS_PROJECT or KEYRING in ResourceSettings.resource_type field."
},
"labels": {
"additionalProperties": {
@@ -649,7 +809,7 @@
"type": "string"
},
"provisionedResourcesParent": {
"description": "Input only. The parent resource for the resources managed by this Assured Workload. May be either an organization or a folder. Must be the same or a child of the Workload parent. If not specified all resources are created under the Workload parent. Formats: folders/{folder_id} organizations/{organization_id}",
"description": "Input only. The parent resource for the resources managed by this Assured Workload. May be either empty or a folder resource which is a child of the Workload parent. If not specified all resources are created under the parent organization. Format: folders/{folder_id}",
"type": "string"
},
"resourceSettings": {
@@ -666,6 +826,11 @@
},
"readOnly": true,
"type": "array"
},
"saaEnrollmentResponse": {
"$ref": "GoogleCloudAssuredworkloadsV1beta1WorkloadSaaEnrollmentResponse",
"description": "Output only. Represents the SAA enrollment response of the given workload. SAA enrollment response is queried during GetWorkload call. In failure cases, user friendly error message is shown in SAA details page.",
"readOnly": true
}
},
"type": "object"
@@ -676,7 +841,7 @@
"properties": {
"kmsSettings": {
"$ref": "GoogleCloudAssuredworkloadsV1beta1WorkloadKMSSettings",
"description": "Required. Input only. Immutable. Settings used to create a CMEK crypto key."
"description": "Input only. Immutable. Settings used to create a CMEK crypto key."
}
},
"type": "object"
@@ -687,7 +852,7 @@
"properties": {
"kmsSettings": {
"$ref": "GoogleCloudAssuredworkloadsV1beta1WorkloadKMSSettings",
"description": "Required. Input only. Immutable. Settings used to create a CMEK crypto key."
"description": "Input only. Immutable. Settings used to create a CMEK crypto key."
}
},
"type": "object"
@@ -698,7 +863,7 @@
"properties": {
"kmsSettings": {
"$ref": "GoogleCloudAssuredworkloadsV1beta1WorkloadKMSSettings",
"description": "Required. Input only. Immutable. Settings used to create a CMEK crypto key."
"description": "Input only. Immutable. Settings used to create a CMEK crypto key."
}
},
"type": "object"
@@ -709,7 +874,7 @@
"properties": {
"kmsSettings": {
"$ref": "GoogleCloudAssuredworkloadsV1beta1WorkloadKMSSettings",
"description": "Required. Input only. Immutable. Settings used to create a CMEK crypto key."
"description": "Input only. Immutable. Settings used to create a CMEK crypto key."
}
},
"type": "object"
@@ -745,12 +910,16 @@
"enum": [
"RESOURCE_TYPE_UNSPECIFIED",
"CONSUMER_PROJECT",
"ENCRYPTION_KEYS_PROJECT"
"CONSUMER_FOLDER",
"ENCRYPTION_KEYS_PROJECT",
"KEYRING"
],
"enumDescriptions": [
"Unknown resource type.",
"Consumer project.",
"Consumer project containing encryption keys."
"Deprecated. Existing workloads will continue to support this, but new CreateWorkloadRequests should not specify this as an input value.",
"Consumer Folder.",
"Consumer project containing encryption keys.",
"Keyring resource that hosts encryption keys."
],
"type": "string"
}
@@ -761,8 +930,12 @@
"description": "Represent the custom settings for the resources to be created.",
"id": "GoogleCloudAssuredworkloadsV1beta1WorkloadResourceSettings",
"properties": {
"displayName": {
"description": "User-assigned resource display name. If not empty it will be used to create a resource with the specified name.",
"type": "string"
},
"resourceId": {
"description": "Resource identifier. For a project this represents project_id. If the project is already taken, the workload creation will fail.",
"description": "Resource identifier. For a project this represents project_id. If the project is already taken, the workload creation will fail. For KeyRing, this represents the keyring_id. For a folder, don't set this value as folder_id is assigned by Google.",
"type": "string"
},
"resourceType": {
@@ -770,12 +943,406 @@
"enum": [
"RESOURCE_TYPE_UNSPECIFIED",
"CONSUMER_PROJECT",
"ENCRYPTION_KEYS_PROJECT"
"CONSUMER_FOLDER",
"ENCRYPTION_KEYS_PROJECT",
"KEYRING"
],
"enumDescriptions": [
"Unknown resource type.",
"Consumer project.",
"Consumer project containing encryption keys."
"Deprecated. Existing workloads will continue to support this, but new CreateWorkloadRequests should not specify this as an input value.",
"Consumer Folder.",
"Consumer project containing encryption keys.",
"Keyring resource that hosts encryption keys."
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAssuredworkloadsV1beta1WorkloadSaaEnrollmentResponse": {
"description": "Signed Access Approvals (SAA) enrollment response.",
"id": "GoogleCloudAssuredworkloadsV1beta1WorkloadSaaEnrollmentResponse",
"properties": {
"setupErrors": {
"description": "Indicates SAA enrollment setup error if any.",
"items": {
"enum": [
"SETUP_ERROR_UNSPECIFIED",
"ERROR_INVALID_BASE_SETUP",
"ERROR_MISSING_EXTERNAL_SIGNING_KEY",
"ERROR_NOT_ALL_SERVICES_ENROLLED",
"ERROR_SETUP_CHECK_FAILED"
],
"enumDescriptions": [
"Unspecified.",
"Invalid states for all customers, to be redirected to AA UI for additional details.",
"Returned when there is not an EKM key configured.",
"Returned when there are no enrolled services or the customer is enrolled in CAA only for a subset of services.",
"Returned when exception was encountered during evaluation of other criteria."
],
"type": "string"
},
"type": "array"
},
"setupStatus": {
"description": "Indicates SAA enrollment status of a given workload.",
"enum": [
"SETUP_STATE_UNSPECIFIED",
"STATUS_PENDING",
"STATUS_COMPLETE"
],
"enumDescriptions": [
"Unspecified.",
"SAA enrollment pending.",
"SAA enrollment comopleted."
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAssuredworkloadsVersioningV1mainCreateWorkloadOperationMetadata": {
"description": "Operation metadata to give request details of CreateWorkload.",
"id": "GoogleCloudAssuredworkloadsVersioningV1mainCreateWorkloadOperationMetadata",
"properties": {
"complianceRegime": {
"description": "Optional. Compliance controls that should be applied to the resources managed by the workload.",
"enum": [
"COMPLIANCE_REGIME_UNSPECIFIED",
"IL4",
"CJIS",
"FEDRAMP_HIGH",
"FEDRAMP_MODERATE",
"US_REGIONAL_ACCESS",
"HIPAA",
"HITRUST",
"EU_REGIONS_AND_SUPPORT",
"CA_REGIONS_AND_SUPPORT"
],
"enumDescriptions": [
"Unknown compliance regime.",
"Information protection as per DoD IL4 requirements.",
"Criminal Justice Information Services (CJIS) Security policies.",
"FedRAMP High data protection controls",
"FedRAMP Moderate data protection controls",
"Assured Workloads For US Regions data protection controls",
"Health Insurance Portability and Accountability Act controls",
"Health Information Trust Alliance controls",
"Assured Workloads For EU Regions and Support controls",
"Assured Workloads For Canada Regions and Support controls"
],
"type": "string"
},
"createTime": {
"description": "Optional. Time when the operation was created.",
"format": "google-datetime",
"type": "string"
},
"displayName": {
"description": "Optional. The display name of the workload.",
"type": "string"
},
"parent": {
"description": "Optional. The parent of the workload.",
"type": "string"
},
"resourceSettings": {
"description": "Optional. Resource properties in the input that are used for creating/customizing workload resources.",
"items": {
"$ref": "GoogleCloudAssuredworkloadsVersioningV1mainWorkloadResourceSettings"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudAssuredworkloadsVersioningV1mainWorkload": {
"description": "An Workload object for managing highly regulated workloads of cloud customers.",
"id": "GoogleCloudAssuredworkloadsVersioningV1mainWorkload",
"properties": {
"billingAccount": {
"description": "Input only. The billing account used for the resources which are direct children of workload. This billing account is initially associated with the resources created as part of Workload creation. After the initial creation of these resources, the customer can change the assigned billing account. The resource name has the form `billingAccounts/{billing_account_id}`. For example, `billingAccounts/012345-567890-ABCDEF`.",
"type": "string"
},
"cjisSettings": {
"$ref": "GoogleCloudAssuredworkloadsVersioningV1mainWorkloadCJISSettings",
"description": "Required. Input only. Immutable. Settings specific to resources needed for CJIS."
},
"complianceRegime": {
"description": "Required. Immutable. Compliance Regime associated with this workload.",
"enum": [
"COMPLIANCE_REGIME_UNSPECIFIED",
"IL4",
"CJIS",
"FEDRAMP_HIGH",
"FEDRAMP_MODERATE",
"US_REGIONAL_ACCESS",
"HIPAA",
"HITRUST",
"EU_REGIONS_AND_SUPPORT",
"CA_REGIONS_AND_SUPPORT"
],
"enumDescriptions": [
"Unknown compliance regime.",
"Information protection as per DoD IL4 requirements.",
"Criminal Justice Information Services (CJIS) Security policies.",
"FedRAMP High data protection controls",
"FedRAMP Moderate data protection controls",
"Assured Workloads For US Regions data protection controls",
"Health Insurance Portability and Accountability Act controls",
"Health Information Trust Alliance controls",
"Assured Workloads For EU Regions and Support controls",
"Assured Workloads For Canada Regions and Support controls"
],
"type": "string"
},
"createTime": {
"description": "Output only. Immutable. The Workload creation timestamp.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"displayName": {
"description": "Required. The user-assigned display name of the Workload. When present it must be between 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, and spaces. Example: My Workload",
"type": "string"
},
"enableSovereignControls": {
"description": "Optional. Indicates the sovereignty status of the given workload. Currently meant to be used by Europe/Canada customers.",
"type": "boolean"
},
"etag": {
"description": "Optional. ETag of the workload, it is calculated on the basis of the Workload contents. It will be used in Update & Delete operations.",
"type": "string"
},
"fedrampHighSettings": {
"$ref": "GoogleCloudAssuredworkloadsVersioningV1mainWorkloadFedrampHighSettings",
"description": "Required. Input only. Immutable. Settings specific to resources needed for FedRAMP High."
},
"fedrampModerateSettings": {
"$ref": "GoogleCloudAssuredworkloadsVersioningV1mainWorkloadFedrampModerateSettings",
"description": "Required. Input only. Immutable. Settings specific to resources needed for FedRAMP Moderate."
},
"il4Settings": {
"$ref": "GoogleCloudAssuredworkloadsVersioningV1mainWorkloadIL4Settings",
"description": "Required. Input only. Immutable. Settings specific to resources needed for IL4."
},
"kajEnrollmentState": {
"description": "Output only. Represents the KAJ enrollment state of the given workload.",
"enum": [
"KAJ_ENROLLMENT_STATE_UNSPECIFIED",
"KAJ_ENROLLMENT_STATE_PENDING",
"KAJ_ENROLLMENT_STATE_COMPLETE"
],
"enumDescriptions": [
"Default State for KAJ Enrollment.",
"Pending State for KAJ Enrollment.",
"Complete State for KAJ Enrollment."
],
"readOnly": true,
"type": "string"
},
"kmsSettings": {
"$ref": "GoogleCloudAssuredworkloadsVersioningV1mainWorkloadKMSSettings",
"description": "Input only. Settings used to create a CMEK crypto key. When set, a project with a KMS CMEK key is provisioned. This field is deprecated as of Feb 28, 2022. In order to create a Keyring, callers should specify, ENCRYPTION_KEYS_PROJECT or KEYRING in ResourceSettings.resource_type field."
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Optional. Labels applied to the workload.",
"type": "object"
},
"name": {
"description": "Optional. The resource name of the workload. Format: organizations/{organization}/locations/{location}/workloads/{workload} Read-only.",
"type": "string"
},
"provisionedResourcesParent": {
"description": "Input only. The parent resource for the resources managed by this Assured Workload. May be either empty or a folder resource which is a child of the Workload parent. If not specified all resources are created under the parent organization. Format: folders/{folder_id}",
"type": "string"
},
"resourceSettings": {
"description": "Input only. Resource properties that are used to customize workload resources. These properties (such as custom project id) will be used to create workload resources if possible. This field is optional.",
"items": {
"$ref": "GoogleCloudAssuredworkloadsVersioningV1mainWorkloadResourceSettings"
},
"type": "array"
},
"resources": {
"description": "Output only. The resources associated with this workload. These resources will be created when creating the workload. If any of the projects already exist, the workload creation will fail. Always read only.",
"items": {
"$ref": "GoogleCloudAssuredworkloadsVersioningV1mainWorkloadResourceInfo"
},
"readOnly": true,
"type": "array"
},
"saaEnrollmentResponse": {
"$ref": "GoogleCloudAssuredworkloadsVersioningV1mainWorkloadSaaEnrollmentResponse",
"description": "Output only. Represents the SAA enrollment response of the given workload. SAA enrollment response is queried during GetWorkload call. In failure cases, user friendly error message is shown in SAA details page.",
"readOnly": true
}
},
"type": "object"
},
"GoogleCloudAssuredworkloadsVersioningV1mainWorkloadCJISSettings": {
"description": "Settings specific to resources needed for CJIS.",
"id": "GoogleCloudAssuredworkloadsVersioningV1mainWorkloadCJISSettings",
"properties": {
"kmsSettings": {
"$ref": "GoogleCloudAssuredworkloadsVersioningV1mainWorkloadKMSSettings",
"description": "Input only. Immutable. Settings used to create a CMEK crypto key."
}
},
"type": "object"
},
"GoogleCloudAssuredworkloadsVersioningV1mainWorkloadFedrampHighSettings": {
"description": "Settings specific to resources needed for FedRAMP High.",
"id": "GoogleCloudAssuredworkloadsVersioningV1mainWorkloadFedrampHighSettings",
"properties": {
"kmsSettings": {
"$ref": "GoogleCloudAssuredworkloadsVersioningV1mainWorkloadKMSSettings",
"description": "Input only. Immutable. Settings used to create a CMEK crypto key."
}
},
"type": "object"
},
"GoogleCloudAssuredworkloadsVersioningV1mainWorkloadFedrampModerateSettings": {
"description": "Settings specific to resources needed for FedRAMP Moderate.",
"id": "GoogleCloudAssuredworkloadsVersioningV1mainWorkloadFedrampModerateSettings",
"properties": {
"kmsSettings": {
"$ref": "GoogleCloudAssuredworkloadsVersioningV1mainWorkloadKMSSettings",
"description": "Input only. Immutable. Settings used to create a CMEK crypto key."
}
},
"type": "object"
},
"GoogleCloudAssuredworkloadsVersioningV1mainWorkloadIL4Settings": {
"description": "Settings specific to resources needed for IL4.",
"id": "GoogleCloudAssuredworkloadsVersioningV1mainWorkloadIL4Settings",
"properties": {
"kmsSettings": {
"$ref": "GoogleCloudAssuredworkloadsVersioningV1mainWorkloadKMSSettings",
"description": "Input only. Immutable. Settings used to create a CMEK crypto key."
}
},
"type": "object"
},
"GoogleCloudAssuredworkloadsVersioningV1mainWorkloadKMSSettings": {
"description": "Settings specific to the Key Management Service.",
"id": "GoogleCloudAssuredworkloadsVersioningV1mainWorkloadKMSSettings",
"properties": {
"nextRotationTime": {
"description": "Required. Input only. Immutable. The time at which the Key Management Service will automatically create a new version of the crypto key and mark it as the primary.",
"format": "google-datetime",
"type": "string"
},
"rotationPeriod": {
"description": "Required. Input only. Immutable. [next_rotation_time] will be advanced by this period when the Key Management Service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours.",
"format": "google-duration",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAssuredworkloadsVersioningV1mainWorkloadResourceInfo": {
"description": "Represent the resources that are children of this Workload.",
"id": "GoogleCloudAssuredworkloadsVersioningV1mainWorkloadResourceInfo",
"properties": {
"resourceId": {
"description": "Resource identifier. For a project this represents project_number.",
"format": "int64",
"type": "string"
},
"resourceType": {
"description": "Indicates the type of resource.",
"enum": [
"RESOURCE_TYPE_UNSPECIFIED",
"CONSUMER_PROJECT",
"CONSUMER_FOLDER",
"ENCRYPTION_KEYS_PROJECT",
"KEYRING"
],
"enumDescriptions": [
"Unknown resource type.",
"Deprecated. Existing workloads will continue to support this, but new CreateWorkloadRequests should not specify this as an input value.",
"Consumer Folder.",
"Consumer project containing encryption keys.",
"Keyring resource that hosts encryption keys."
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAssuredworkloadsVersioningV1mainWorkloadResourceSettings": {
"description": "Represent the custom settings for the resources to be created.",
"id": "GoogleCloudAssuredworkloadsVersioningV1mainWorkloadResourceSettings",
"properties": {
"displayName": {
"description": "User-assigned resource display name. If not empty it will be used to create a resource with the specified name.",
"type": "string"
},
"resourceId": {
"description": "Resource identifier. For a project this represents project_id. If the project is already taken, the workload creation will fail. For KeyRing, this represents the keyring_id. For a folder, don't set this value as folder_id is assigned by Google.",
"type": "string"
},
"resourceType": {
"description": "Indicates the type of resource. This field should be specified to correspond the id to the right project type (CONSUMER_PROJECT or ENCRYPTION_KEYS_PROJECT)",
"enum": [
"RESOURCE_TYPE_UNSPECIFIED",
"CONSUMER_PROJECT",
"CONSUMER_FOLDER",
"ENCRYPTION_KEYS_PROJECT",
"KEYRING"
],
"enumDescriptions": [
"Unknown resource type.",
"Deprecated. Existing workloads will continue to support this, but new CreateWorkloadRequests should not specify this as an input value.",
"Consumer Folder.",
"Consumer project containing encryption keys.",
"Keyring resource that hosts encryption keys."
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAssuredworkloadsVersioningV1mainWorkloadSaaEnrollmentResponse": {
"description": "Signed Access Approvals (SAA) enrollment response.",
"id": "GoogleCloudAssuredworkloadsVersioningV1mainWorkloadSaaEnrollmentResponse",
"properties": {
"setupErrors": {
"description": "Indicates SAA enrollment setup error if any.",
"items": {
"enum": [
"SETUP_ERROR_UNSPECIFIED",
"ERROR_INVALID_BASE_SETUP",
"ERROR_MISSING_EXTERNAL_SIGNING_KEY",
"ERROR_NOT_ALL_SERVICES_ENROLLED",
"ERROR_SETUP_CHECK_FAILED"
],
"enumDescriptions": [
"Unspecified.",
"Invalid states for all customers, to be redirected to AA UI for additional details.",
"Returned when there is not an EKM key configured.",
"Returned when there are no enrolled services or the customer is enrolled in CAA only for a subset of services.",
"Returned when exception was encountered during evaluation of other criteria."
],
"type": "string"
},
"type": "array"
},
"setupStatus": {
"description": "Indicates SAA enrollment status of a given workload.",
"enum": [
"SETUP_STATE_UNSPECIFIED",
"STATUS_PENDING",
"STATUS_COMPLETE"
],
"enumDescriptions": [
"Unspecified.",
"SAA enrollment pending.",
"SAA enrollment comopleted."
],
"type": "string"
}

3100
etc/api/authorizedbuyersmarketplace/v1/authorizedbuyersmarketplace-api.json Normal file
View File

File diff suppressed because it is too large Load Diff

383
etc/api/baremetalsolution/v1/baremetalsolution-api.json Normal file
View File

@@ -0,0 +1,383 @@
{
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
}
}
}
},
"basePath": "",
"baseUrl": "https://baremetalsolution.googleapis.com/",
"batchPath": "batch",
"description": "Provides ways to manage Bare Metal Solution hardware installed in a regional extension located near a Google Cloud data center.",
"discoveryVersion": "v1",
"documentationLink": "https://cloud.google.com/bare-metal",
"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": "baremetalsolution:v1",
"kind": "discovery#restDescription",
"mtlsRootUrl": "https://baremetalsolution.mtls.googleapis.com/",
"name": "baremetalsolution",
"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": {
"operations": {
"methods": {
"cancel": {
"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.",
"flatPath": "v1/operations/{operationsId}:cancel",
"httpMethod": "POST",
"id": "baremetalsolution.operations.cancel",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource to be cancelled.",
"location": "path",
"pattern": "^operations/.*$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:cancel",
"request": {
"$ref": "CancelOperationRequest"
},
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
"flatPath": "v1/operations/{operationsId}",
"httpMethod": "DELETE",
"id": "baremetalsolution.operations.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource to be deleted.",
"location": "path",
"pattern": "^operations/.*$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
"flatPath": "v1/operations/{operationsId}",
"httpMethod": "GET",
"id": "baremetalsolution.operations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource.",
"location": "path",
"pattern": "^operations/.*$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `\"/v1/{name=users/*}/operations\"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.",
"flatPath": "v1/operations",
"httpMethod": "GET",
"id": "baremetalsolution.operations.list",
"parameterOrder": [
"name"
],
"parameters": {
"filter": {
"description": "The standard list filter.",
"location": "query",
"type": "string"
},
"name": {
"description": "The name of the operation's parent resource.",
"location": "path",
"pattern": "^operations$",
"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}",
"response": {
"$ref": "ListOperationsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"projects": {
"resources": {
"locations": {
"resources": {
"instances": {
"methods": {
"resetInstance": {
"description": "Perform an ungraceful, hard reset on a machine (equivalent to shutting the power off, and then turning it back on).",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:resetInstance",
"httpMethod": "POST",
"id": "baremetalsolution.projects.locations.instances.resetInstance",
"parameterOrder": [
"instance"
],
"parameters": {
"instance": {
"description": "Required. Name of the instance to reset.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+instance}:resetInstance",
"request": {
"$ref": "ResetInstanceRequest"
},
"response": {
"$ref": "ResetInstanceResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
}
}
}
},
"revision": "20220209",
"rootUrl": "https://baremetalsolution.googleapis.com/",
"schemas": {
"CancelOperationRequest": {
"description": "The request message for Operations.CancelOperation.",
"id": "CancelOperationRequest",
"properties": {},
"type": "object"
},
"Empty": {
"description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.",
"id": "Empty",
"properties": {},
"type": "object"
},
"ListOperationsResponse": {
"description": "The response message for Operations.ListOperations.",
"id": "ListOperationsResponse",
"properties": {
"nextPageToken": {
"description": "The standard List next-page token.",
"type": "string"
},
"operations": {
"description": "A list of operations that matches the specified filter in the request.",
"items": {
"$ref": "Operation"
},
"type": "array"
}
},
"type": "object"
},
"Operation": {
"description": "This resource represents a long-running operation that is the result of a network API call.",
"id": "Operation",
"properties": {
"done": {
"description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.",
"type": "boolean"
},
"error": {
"$ref": "Status",
"description": "The error result of the operation in case of failure or cancellation."
},
"metadata": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.",
"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 be a resource name ending with `operations/{unique_id}`.",
"type": "string"
},
"response": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"description": "The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.",
"type": "object"
}
},
"type": "object"
},
"ResetInstanceRequest": {
"description": "Request for ResetInstance.",
"id": "ResetInstanceRequest",
"properties": {},
"type": "object"
},
"ResetInstanceResponse": {
"description": "Response for ResetInstance.",
"id": "ResetInstanceResponse",
"properties": {},
"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). 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": {
"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 message 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 user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.",
"type": "string"
}
},
"type": "object"
}
},
"servicePath": "",
"title": "Bare Metal Solution API",
"version": "v1",
"version_module": true
}

2540
etc/api/baremetalsolution/v2/baremetalsolution-api.json Normal file
View File

File diff suppressed because it is too large Load Diff

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

File diff suppressed because it is too large Load Diff

20
etc/api/bigqueryconnection/v1beta1/bigqueryconnection-api.json
View File

@@ -3,10 +3,10 @@
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/bigquery": {
"description": "View and manage your data in Google BigQuery"
"description": "View and manage your data in Google BigQuery and see the email address for your Google Account"
},
"https://www.googleapis.com/auth/cloud-platform": {
"description": "See, edit, configure, and delete your Google Cloud Platform data"
"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
}
}
}
@@ -395,7 +395,7 @@
}
}
},
"revision": "20210326",
"revision": "20220226",
"rootUrl": "https://bigqueryconnection.googleapis.com/",
"schemas": {
"AuditConfig": {
@@ -447,22 +447,22 @@
"type": "object"
},
"Binding": {
"description": "Associates `members` with a `role`.",
"description": "Associates `members`, or principals, with a `role`.",
"id": "Binding",
"properties": {
"condition": {
"$ref": "Expr",
"description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)."
"description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)."
},
"members": {
"description": "Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ",
"description": "Specifies the principals requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ",
"items": {
"type": "string"
},
"type": "array"
},
"role": {
"description": "Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.",
"description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.",
"type": "string"
}
},
@@ -612,7 +612,7 @@
"id": "GetPolicyOptions",
"properties": {
"requestedPolicyVersion": {
"description": "Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
"format": "int32",
"type": "integer"
}
@@ -638,7 +638,7 @@
"type": "object"
},
"Policy": {
"description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).",
"description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).",
"id": "Policy",
"properties": {
"auditConfigs": {
@@ -649,7 +649,7 @@
"type": "array"
},
"bindings": {
"description": "Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.",
"description": "Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.",
"items": {
"$ref": "Binding"
},

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

@@ -3,16 +3,13 @@
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/bigquery": {
"description": "View and manage your data in Google BigQuery"
},
"https://www.googleapis.com/auth/bigquery.readonly": {
"description": "View your data in Google BigQuery"
"description": "View and manage your data in Google BigQuery and see the email address for your Google Account"
},
"https://www.googleapis.com/auth/cloud-platform": {
"description": "See, edit, configure, and delete your Google Cloud Platform data"
"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
},
"https://www.googleapis.com/auth/cloud-platform.read-only": {
"description": "View your data across Google Cloud Platform services"
"description": "View your data across Google Cloud services and see the email address of your Google Account"
}
}
}
@@ -115,11 +112,42 @@
"protocol": "rest",
"resources": {
"projects": {
"methods": {
"enrollDataSources": {
"description": "Enroll data sources in a user project. This allows users to create transfer configurations for these data sources. They will also appear in the ListDataSources RPC and as such, will appear in the BigQuery UI 'https://bigquery.cloud.google.com' (and the documents can be found at https://cloud.google.com/bigquery/bigquery-web-ui and https://cloud.google.com/bigquery/docs/working-with-transfers).",
"flatPath": "v1/projects/{projectsId}:enrollDataSources",
"httpMethod": "POST",
"id": "bigquerydatatransfer.projects.enrollDataSources",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the project resource in the form: `projects/{project_id}`",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:enrollDataSources",
"request": {
"$ref": "EnrollDataSourcesRequest"
},
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/bigquery",
"https://www.googleapis.com/auth/cloud-platform"
]
}
},
"resources": {
"dataSources": {
"methods": {
"checkValidCreds": {
"description": "Returns true if valid credentials exist for the given data source and requesting user. Some data sources doesn't support service account, so we need to talk to them on behalf of the end user. This API just checks whether we have OAuth token for the particular user, which is a pre-requisite before user can create a transfer config.",
"description": "Returns true if valid credentials exist for the given data source and requesting user.",
"flatPath": "v1/projects/{projectsId}/dataSources/{dataSourcesId}:checkValidCreds",
"httpMethod": "POST",
"id": "bigquerydatatransfer.projects.dataSources.checkValidCreds",
@@ -144,13 +172,12 @@
},
"scopes": [
"https://www.googleapis.com/auth/bigquery",
"https://www.googleapis.com/auth/bigquery.readonly",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
]
},
"get": {
"description": "Retrieves a supported data source and returns its settings, which can be used for UI rendering.",
"description": "Retrieves a supported data source and returns its settings.",
"flatPath": "v1/projects/{projectsId}/dataSources/{dataSourcesId}",
"httpMethod": "GET",
"id": "bigquerydatatransfer.projects.dataSources.get",
@@ -172,13 +199,12 @@
},
"scopes": [
"https://www.googleapis.com/auth/bigquery",
"https://www.googleapis.com/auth/bigquery.readonly",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
]
},
"list": {
"description": "Lists supported data sources and returns their settings, which can be used for UI rendering.",
"description": "Lists supported data sources and returns their settings.",
"flatPath": "v1/projects/{projectsId}/dataSources",
"httpMethod": "GET",
"id": "bigquerydatatransfer.projects.dataSources.list",
@@ -198,7 +224,7 @@
"type": "string"
},
"parent": {
"description": "Required. The BigQuery project id for which data sources should be returned. Must be in the form: `projects/{project_id}` or `projects/{project_id}/locations/{location_id}",
"description": "Required. The BigQuery project id for which data sources should be returned. Must be in the form: `projects/{project_id}` or `projects/{project_id}/locations/{location_id}`",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
@@ -211,7 +237,6 @@
},
"scopes": [
"https://www.googleapis.com/auth/bigquery",
"https://www.googleapis.com/auth/bigquery.readonly",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
]
@@ -220,6 +245,35 @@
},
"locations": {
"methods": {
"enrollDataSources": {
"description": "Enroll data sources in a user project. This allows users to create transfer configurations for these data sources. They will also appear in the ListDataSources RPC and as such, will appear in the BigQuery UI 'https://bigquery.cloud.google.com' (and the documents can be found at https://cloud.google.com/bigquery/bigquery-web-ui and https://cloud.google.com/bigquery/docs/working-with-transfers).",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}:enrollDataSources",
"httpMethod": "POST",
"id": "bigquerydatatransfer.projects.locations.enrollDataSources",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the project resource in the form: `projects/{project_id}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:enrollDataSources",
"request": {
"$ref": "EnrollDataSourcesRequest"
},
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/bigquery",
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets information about a location.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}",
@@ -243,7 +297,6 @@
},
"scopes": [
"https://www.googleapis.com/auth/bigquery",
"https://www.googleapis.com/auth/bigquery.readonly",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
]
@@ -270,7 +323,7 @@
"type": "string"
},
"pageSize": {
"description": "The maximum number of results to return. If not set, the service will select a default.",
"description": "The maximum number of results to return. If not set, the service selects a default.",
"format": "int32",
"location": "query",
"type": "integer"
@@ -287,7 +340,6 @@
},
"scopes": [
"https://www.googleapis.com/auth/bigquery",
"https://www.googleapis.com/auth/bigquery.readonly",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
]
@@ -297,7 +349,7 @@
"dataSources": {
"methods": {
"checkValidCreds": {
"description": "Returns true if valid credentials exist for the given data source and requesting user. Some data sources doesn't support service account, so we need to talk to them on behalf of the end user. This API just checks whether we have OAuth token for the particular user, which is a pre-requisite before user can create a transfer config.",
"description": "Returns true if valid credentials exist for the given data source and requesting user.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataSources/{dataSourcesId}:checkValidCreds",
"httpMethod": "POST",
"id": "bigquerydatatransfer.projects.locations.dataSources.checkValidCreds",
@@ -322,13 +374,12 @@
},
"scopes": [
"https://www.googleapis.com/auth/bigquery",
"https://www.googleapis.com/auth/bigquery.readonly",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
]
},
"get": {
"description": "Retrieves a supported data source and returns its settings, which can be used for UI rendering.",
"description": "Retrieves a supported data source and returns its settings.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataSources/{dataSourcesId}",
"httpMethod": "GET",
"id": "bigquerydatatransfer.projects.locations.dataSources.get",
@@ -350,13 +401,12 @@
},
"scopes": [
"https://www.googleapis.com/auth/bigquery",
"https://www.googleapis.com/auth/bigquery.readonly",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
]
},
"list": {
"description": "Lists supported data sources and returns their settings, which can be used for UI rendering.",
"description": "Lists supported data sources and returns their settings.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataSources",
"httpMethod": "GET",
"id": "bigquerydatatransfer.projects.locations.dataSources.list",
@@ -376,7 +426,7 @@
"type": "string"
},
"parent": {
"description": "Required. The BigQuery project id for which data sources should be returned. Must be in the form: `projects/{project_id}` or `projects/{project_id}/locations/{location_id}",
"description": "Required. The BigQuery project id for which data sources should be returned. Must be in the form: `projects/{project_id}` or `projects/{project_id}/locations/{location_id}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
@@ -389,7 +439,6 @@
},
"scopes": [
"https://www.googleapis.com/auth/bigquery",
"https://www.googleapis.com/auth/bigquery.readonly",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
]
@@ -408,7 +457,7 @@
],
"parameters": {
"authorizationCode": {
"description": "Optional OAuth2 authorization code to use with this transfer configuration. This is required if new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain authorization_code, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri= * client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. * redirect_uri is an optional parameter. If not specified, then authorization code is posted to the opener of authorization flow window. Otherwise it will be sent to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means that authorization code should be returned in the title bar of the browser, with the page text prompting the user to copy the code and paste it in the application.",
"description": "Optional OAuth2 authorization code to use with this transfer configuration. This is required only if `transferConfig.dataSourceId` is 'youtube_channel' and new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain authorization_code, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code * client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is used to create the transfer config.",
"location": "query",
"type": "string"
},
@@ -420,12 +469,12 @@
"type": "string"
},
"serviceAccountName": {
"description": "Optional service account name. If this field is set, transfer config will be created with this service account credentials. It requires that requesting user calling this API has permissions to act as this service account.",
"description": "Optional service account name. If this field is set, transfer config will be created with this service account credential. It requires that requesting user calling this API has permissions to act as this service account. Note that not all data sources support service account credentials when creating transfer config. Please refer to this public guide for the latest list of data sources with service account support: https://cloud.google.com/bigquery-transfer/docs/use-service-accounts",
"location": "query",
"type": "string"
},
"versionInfo": {
"description": "Optional version info. If users want to find a very recent access token, that is, immediately after approving access, users have to set the version_info claim in the token request. To obtain the version_info, users must use the \"none+gsession\" response type. which be return a version_info back in the authorization response which be be put in a JWT claim in the token request.",
"description": "Optional version info. This is required only if `transferConfig.dataSourceId` is anything else but 'youtube_channel' and new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain version info, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info * client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is used to create the transfer config.",
"location": "query",
"type": "string"
}
@@ -490,13 +539,12 @@
},
"scopes": [
"https://www.googleapis.com/auth/bigquery",
"https://www.googleapis.com/auth/bigquery.readonly",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
]
},
"list": {
"description": "Returns information about all data transfers in the project.",
"description": "Returns information about all transfer configs owned by a project in the specified location.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs",
"httpMethod": "GET",
"id": "bigquerydatatransfer.projects.locations.transferConfigs.list",
@@ -522,7 +570,7 @@
"type": "string"
},
"parent": {
"description": "Required. The BigQuery project id for which data sources should be returned: `projects/{project_id}` or `projects/{project_id}/locations/{location_id}`",
"description": "Required. The BigQuery project id for which transfer configs should be returned: `projects/{project_id}` or `projects/{project_id}/locations/{location_id}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
@@ -535,7 +583,6 @@
},
"scopes": [
"https://www.googleapis.com/auth/bigquery",
"https://www.googleapis.com/auth/bigquery.readonly",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
]
@@ -550,7 +597,7 @@
],
"parameters": {
"authorizationCode": {
"description": "Optional OAuth2 authorization code to use with this transfer configuration. If it is provided, the transfer configuration will be associated with the authorizing user. In order to obtain authorization_code, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri= * client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. * redirect_uri is an optional parameter. If not specified, then authorization code is posted to the opener of authorization flow window. Otherwise it will be sent to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means that authorization code should be returned in the title bar of the browser, with the page text prompting the user to copy the code and paste it in the application.",
"description": "Optional OAuth2 authorization code to use with this transfer configuration. This is required only if `transferConfig.dataSourceId` is 'youtube_channel' and new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain authorization_code, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code * client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is used to create the transfer config.",
"location": "query",
"type": "string"
},
@@ -562,7 +609,7 @@
"type": "string"
},
"serviceAccountName": {
"description": "Optional service account name. If this field is set and \"service_account_name\" is set in update_mask, transfer config will be updated to use this service account credentials. It requires that requesting user calling this API has permissions to act as this service account.",
"description": "Optional service account name. If this field is set and \"service_account_name\" is set in update_mask, transfer config will be created with this service account credential. It requires that requesting user calling this API has permissions to act as this service account. Note that not all data sources support service account credentials when creating transfer config. Please refer to this public guide for the latest list of data sources with service account support: https://cloud.google.com/bigquery-transfer/docs/use-service-accounts",
"location": "query",
"type": "string"
},
@@ -573,7 +620,7 @@
"type": "string"
},
"versionInfo": {
"description": "Optional version info. If users want to find a very recent access token, that is, immediately after approving access, users have to set the version_info claim in the token request. To obtain the version_info, users must use the \"none+gsession\" response type. which be return a version_info back in the authorization response which be be put in a JWT claim in the token request.",
"description": "Optional version info. This is required only if `transferConfig.dataSourceId` is anything else but 'youtube_channel' and new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain version info, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info * client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is used to create the transfer config.",
"location": "query",
"type": "string"
}
@@ -700,13 +747,12 @@
},
"scopes": [
"https://www.googleapis.com/auth/bigquery",
"https://www.googleapis.com/auth/bigquery.readonly",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
]
},
"list": {
"description": "Returns information about running and completed jobs.",
"description": "Returns information about running and completed transfer runs.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs",
"httpMethod": "GET",
"id": "bigquerydatatransfer.projects.locations.transferConfigs.runs.list",
@@ -774,7 +820,6 @@
},
"scopes": [
"https://www.googleapis.com/auth/bigquery",
"https://www.googleapis.com/auth/bigquery.readonly",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
]
@@ -784,7 +829,7 @@
"transferLogs": {
"methods": {
"list": {
"description": "Returns user facing log messages for the data transfer run.",
"description": "Returns log messages for the transfer run.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs/{runsId}/transferLogs",
"httpMethod": "GET",
"id": "bigquerydatatransfer.projects.locations.transferConfigs.runs.transferLogs.list",
@@ -835,7 +880,6 @@
},
"scopes": [
"https://www.googleapis.com/auth/bigquery",
"https://www.googleapis.com/auth/bigquery.readonly",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
]
@@ -860,7 +904,7 @@
],
"parameters": {
"authorizationCode": {
"description": "Optional OAuth2 authorization code to use with this transfer configuration. This is required if new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain authorization_code, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri= * client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. * redirect_uri is an optional parameter. If not specified, then authorization code is posted to the opener of authorization flow window. Otherwise it will be sent to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means that authorization code should be returned in the title bar of the browser, with the page text prompting the user to copy the code and paste it in the application.",
"description": "Optional OAuth2 authorization code to use with this transfer configuration. This is required only if `transferConfig.dataSourceId` is 'youtube_channel' and new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain authorization_code, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code * client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is used to create the transfer config.",
"location": "query",
"type": "string"
},
@@ -872,12 +916,12 @@
"type": "string"
},
"serviceAccountName": {
"description": "Optional service account name. If this field is set, transfer config will be created with this service account credentials. It requires that requesting user calling this API has permissions to act as this service account.",
"description": "Optional service account name. If this field is set, transfer config will be created with this service account credential. It requires that requesting user calling this API has permissions to act as this service account. Note that not all data sources support service account credentials when creating transfer config. Please refer to this public guide for the latest list of data sources with service account support: https://cloud.google.com/bigquery-transfer/docs/use-service-accounts",
"location": "query",
"type": "string"
},
"versionInfo": {
"description": "Optional version info. If users want to find a very recent access token, that is, immediately after approving access, users have to set the version_info claim in the token request. To obtain the version_info, users must use the \"none+gsession\" response type. which be return a version_info back in the authorization response which be be put in a JWT claim in the token request.",
"description": "Optional version info. This is required only if `transferConfig.dataSourceId` is anything else but 'youtube_channel' and new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain version info, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info * client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is used to create the transfer config.",
"location": "query",
"type": "string"
}
@@ -942,13 +986,12 @@
},
"scopes": [
"https://www.googleapis.com/auth/bigquery",
"https://www.googleapis.com/auth/bigquery.readonly",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
]
},
"list": {
"description": "Returns information about all data transfers in the project.",
"description": "Returns information about all transfer configs owned by a project in the specified location.",
"flatPath": "v1/projects/{projectsId}/transferConfigs",
"httpMethod": "GET",
"id": "bigquerydatatransfer.projects.transferConfigs.list",
@@ -974,7 +1017,7 @@
"type": "string"
},
"parent": {
"description": "Required. The BigQuery project id for which data sources should be returned: `projects/{project_id}` or `projects/{project_id}/locations/{location_id}`",
"description": "Required. The BigQuery project id for which transfer configs should be returned: `projects/{project_id}` or `projects/{project_id}/locations/{location_id}`",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
@@ -987,7 +1030,6 @@
},
"scopes": [
"https://www.googleapis.com/auth/bigquery",
"https://www.googleapis.com/auth/bigquery.readonly",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
]
@@ -1002,7 +1044,7 @@
],
"parameters": {
"authorizationCode": {
"description": "Optional OAuth2 authorization code to use with this transfer configuration. If it is provided, the transfer configuration will be associated with the authorizing user. In order to obtain authorization_code, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri= * client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. * redirect_uri is an optional parameter. If not specified, then authorization code is posted to the opener of authorization flow window. Otherwise it will be sent to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means that authorization code should be returned in the title bar of the browser, with the page text prompting the user to copy the code and paste it in the application.",
"description": "Optional OAuth2 authorization code to use with this transfer configuration. This is required only if `transferConfig.dataSourceId` is 'youtube_channel' and new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain authorization_code, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code * client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is used to create the transfer config.",
"location": "query",
"type": "string"
},
@@ -1014,7 +1056,7 @@
"type": "string"
},
"serviceAccountName": {
"description": "Optional service account name. If this field is set and \"service_account_name\" is set in update_mask, transfer config will be updated to use this service account credentials. It requires that requesting user calling this API has permissions to act as this service account.",
"description": "Optional service account name. If this field is set and \"service_account_name\" is set in update_mask, transfer config will be created with this service account credential. It requires that requesting user calling this API has permissions to act as this service account. Note that not all data sources support service account credentials when creating transfer config. Please refer to this public guide for the latest list of data sources with service account support: https://cloud.google.com/bigquery-transfer/docs/use-service-accounts",
"location": "query",
"type": "string"
},
@@ -1025,7 +1067,7 @@
"type": "string"
},
"versionInfo": {
"description": "Optional version info. If users want to find a very recent access token, that is, immediately after approving access, users have to set the version_info claim in the token request. To obtain the version_info, users must use the \"none+gsession\" response type. which be return a version_info back in the authorization response which be be put in a JWT claim in the token request.",
"description": "Optional version info. This is required only if `transferConfig.dataSourceId` is anything else but 'youtube_channel' and new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain version info, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info * client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is used to create the transfer config.",
"location": "query",
"type": "string"
}
@@ -1152,13 +1194,12 @@
},
"scopes": [
"https://www.googleapis.com/auth/bigquery",
"https://www.googleapis.com/auth/bigquery.readonly",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
]
},
"list": {
"description": "Returns information about running and completed jobs.",
"description": "Returns information about running and completed transfer runs.",
"flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}/runs",
"httpMethod": "GET",
"id": "bigquerydatatransfer.projects.transferConfigs.runs.list",
@@ -1226,7 +1267,6 @@
},
"scopes": [
"https://www.googleapis.com/auth/bigquery",
"https://www.googleapis.com/auth/bigquery.readonly",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
]
@@ -1236,7 +1276,7 @@
"transferLogs": {
"methods": {
"list": {
"description": "Returns user facing log messages for the data transfer run.",
"description": "Returns log messages for the transfer run.",
"flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}/runs/{runsId}/transferLogs",
"httpMethod": "GET",
"id": "bigquerydatatransfer.projects.transferConfigs.runs.transferLogs.list",
@@ -1287,7 +1327,6 @@
},
"scopes": [
"https://www.googleapis.com/auth/bigquery",
"https://www.googleapis.com/auth/bigquery.readonly",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
]
@@ -1301,7 +1340,7 @@
}
}
},
"revision": "20210324",
"revision": "20220225",
"rootUrl": "https://bigquerydatatransfer.googleapis.com/",
"schemas": {
"CheckValidCredsRequest": {
@@ -1322,7 +1361,7 @@
"type": "object"
},
"DataSource": {
"description": "Represents data source metadata. Metadata is sufficient to render UI and request proper OAuth tokens.",
"description": "Defines the properties and custom parameters for a data source.",
"id": "DataSource",
"properties": {
"authorizationType": {
@@ -1337,7 +1376,7 @@
"Type unspecified.",
"Use OAuth 2 authorization codes that can be exchanged for a refresh token on the backend.",
"Return an authorization code for a given Google+ page that can then be exchanged for a refresh token on the backend.",
"Use First Party OAuth based on Loas Owned Clients. First Party OAuth doesn't require a refresh token to get an offline access token. Instead, it uses a client-signed JWT assertion to retrieve an access token."
"Use First Party OAuth."
],
"type": "string"
},
@@ -1443,7 +1482,7 @@
"type": "object"
},
"DataSourceParameter": {
"description": "Represents a data source parameter with validation rules, so that parameters can be rendered in the UI. These parameters are given to us by supported data sources, and include all needed information for rendering and validation. Thus, whoever uses this api can decide to generate either generic ui, or custom data source specific forms.",
"description": "A parameter used to define custom fields in a data source definition.",
"id": "DataSourceParameter",
"properties": {
"allowedValues": {
@@ -1556,6 +1595,20 @@
"properties": {},
"type": "object"
},
"EnrollDataSourcesRequest": {
"description": "A request to enroll a set of data sources so they are visible in the BigQuery UI's `Transfer` tab.",
"id": "EnrollDataSourcesRequest",
"properties": {
"dataSourceIds": {
"description": "Data sources that are enrolled. It is required to provide at least one data source id.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ListDataSourcesResponse": {
"description": "Returns list of supported data sources and their metadata.",
"id": "ListDataSourcesResponse",
@@ -1858,9 +1911,14 @@
"type": "string"
},
"notificationPubsubTopic": {
"description": "Pub/Sub topic where notifications will be sent after transfer runs associated with this transfer config finish.",
"description": "Pub/Sub topic where notifications will be sent after transfer runs associated with this transfer config finish. The format for specifying a pubsub topic is: `projects/{project}/topics/{topic}`",
"type": "string"
},
"ownerInfo": {
"$ref": "UserInfo",
"description": "Output only. Information about the user whose credentials are used to transfer data. Populated only for `transferConfigs.get` requests. In case the user information is not available, this field will not be populated.",
"readOnly": true
},
"params": {
"additionalProperties": {
"description": "Properties of the object.",
@@ -1870,7 +1928,7 @@
"type": "object"
},
"schedule": {
"description": "Data transfer schedule. If the data source does not support a custom schedule, this should be empty. If it is empty, the default value for the data source will be used. The specified times are in UTC. Examples of valid format: `1st,3rd monday of month 15:30`, `every wed,fri of jan,jun 13:15`, and `first sunday of quarter 00:00`. See more explanation about the format here: https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format NOTE: the granularity should be at least 8 hours, or less frequent.",
"description": "Data transfer schedule. If the data source does not support a custom schedule, this should be empty. If it is empty, the default value for the data source will be used. The specified times are in UTC. Examples of valid format: `1st,3rd monday of month 15:30`, `every wed,fri of jan,jun 13:15`, and `first sunday of quarter 00:00`. See more explanation about the format here: https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format NOTE: The minimum interval time between recurring transfers depends on the data source; refer to the documentation for your data source.",
"type": "string"
},
"scheduleOptions": {
@@ -1978,7 +2036,7 @@
"type": "string"
},
"notificationPubsubTopic": {
"description": "Output only. Pub/Sub topic where a notification will be sent after this transfer run finishes",
"description": "Output only. Pub/Sub topic where a notification will be sent after this transfer run finishes. The format for specifying a pubsub topic is: `projects/{project}/topics/{topic}`",
"readOnly": true,
"type": "string"
},
@@ -2045,6 +2103,17 @@
}
},
"type": "object"
},
"UserInfo": {
"description": "Information about a user.",
"id": "UserInfo",
"properties": {
"email": {
"description": "E-mail address of the user.",
"type": "string"
}
},
"type": "object"
}
},
"servicePath": "",

58
etc/api/bigqueryreservation/v1/bigqueryreservation-api.json
View File

@@ -3,10 +3,10 @@
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/bigquery": {
"description": "View and manage your data in Google BigQuery"
"description": "View and manage your data in Google BigQuery and see the email address for your Google Account"
},
"https://www.googleapis.com/auth/cloud-platform": {
"description": "See, edit, configure, and delete your Google Cloud Platform data"
"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
}
}
}
@@ -181,7 +181,7 @@
]
},
"searchAssignments": {
"description": "Looks up assignments for a specified resource for a particular region. If the request is about a project: 1. Assignments created on the project will be returned if they exist. 2. Otherwise assignments created on the closest ancestor will be returned. 3. Assignments for different JobTypes will all be returned. The same logic applies if the request is about a folder. If the request is about an organization, then assignments created on the organization will be returned (organization doesn't have ancestors). Comparing to ListAssignments, there are some behavior differences: 1. permission on the assignee will be verified in this API. 2. Hierarchy lookup (project->folder->organization) happens in this API. 3. Parent here is `projects/*/locations/*`, instead of `projects/*/locations/*reservations/*`. **Note** \"-\" cannot be used for projects nor locations.",
"description": "Deprecated: Looks up assignments for a specified resource for a particular region. If the request is about a project: 1. Assignments created on the project will be returned if they exist. 2. Otherwise assignments created on the closest ancestor will be returned. 3. Assignments for different JobTypes will all be returned. The same logic applies if the request is about a folder. If the request is about an organization, then assignments created on the organization will be returned (organization doesn't have ancestors). Comparing to ListAssignments, there are some behavior differences: 1. permission on the assignee will be verified in this API. 2. Hierarchy lookup (project->folder->organization) happens in this API. 3. Parent here is `projects/*/locations/*`, instead of `projects/*/locations/*reservations/*`. **Note** \"-\" cannot be used for projects nor locations.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}:searchAssignments",
"httpMethod": "GET",
"id": "bigqueryreservation.projects.locations.searchAssignments",
@@ -270,6 +270,11 @@
"parent"
],
"parameters": {
"capacityCommitmentId": {
"description": "The optional capacity commitment ID. Capacity commitment name will be generated automatically if this field is empty. This field must only contain lower case alphanumeric characters or dashes. The first and last character cannot be a dash. Max length is 64 characters. NOTE: this ID won't be kept if the capacity commitment is split or merged.",
"location": "query",
"type": "string"
},
"enforceSingleAdminProjectPerOrg": {
"description": "If true, fail the request if another project in the organization has a capacity commitment.",
"location": "query",
@@ -304,6 +309,11 @@
"name"
],
"parameters": {
"force": {
"description": "Can be used to force delete commitments even if assignments exist. Deleting commitments with assignments may cause queries to fail if they no longer have access to slots.",
"location": "query",
"type": "boolean"
},
"name": {
"description": "Required. Resource name of the capacity commitment to delete. E.g., `projects/myproject/locations/US/capacityCommitments/123`",
"location": "path",
@@ -423,7 +433,7 @@
],
"parameters": {
"name": {
"description": "Output only. The resource name of the capacity commitment, e.g., `projects/myproject/locations/US/capacityCommitments/123`",
"description": "Output only. The resource name of the capacity commitment, e.g., `projects/myproject/locations/US/capacityCommitments/123` For the commitment id, it must only contain lower case alphanumeric characters or dashes.It must start with a letter and must not end with a dash. Its maximum length is 64 characters.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/capacityCommitments/[^/]+$",
"required": true,
@@ -498,7 +508,7 @@
"type": "string"
},
"reservationId": {
"description": "The reservation ID. This field must only contain lower case alphanumeric characters or dash. Max length is 64 characters.",
"description": "The reservation ID. It must only contain lower case alphanumeric characters or dashes.It must start with a letter and must not end with a dash. Its maximum length is 64 characters.",
"location": "query",
"type": "string"
}
@@ -614,7 +624,7 @@
],
"parameters": {
"name": {
"description": "The resource name of the reservation, e.g., `projects/*/locations/*/reservations/team1-prod`.",
"description": "The resource name of the reservation, e.g., `projects/*/locations/*/reservations/team1-prod`. For the reservation id, it must only contain lower case alphanumeric characters or dashes.It must start with a letter and must not end with a dash. Its maximum length is 64 characters.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/reservations/[^/]+$",
"required": true,
@@ -652,6 +662,11 @@
"parent"
],
"parameters": {
"assignmentId": {
"description": "The optional assignment ID. Assignment name will be generated automatically if this field is empty. This field must only contain lower case alphanumeric characters or dashes. Max length is 64 characters.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The parent resource name of the assignment E.g. `projects/myproject/locations/US/reservations/team1-prod`",
"location": "path",
@@ -773,11 +788,11 @@
}
}
},
"revision": "20210324",
"revision": "20220226",
"rootUrl": "https://bigqueryreservation.googleapis.com/",
"schemas": {
"Assignment": {
"description": "A Assignment allows a project to submit jobs of a certain type using slots from the specified reservation.",
"description": "An assignment allows a project to submit jobs of a certain type using slots from the specified reservation.",
"id": "Assignment",
"properties": {
"assignee": {
@@ -801,7 +816,7 @@
"type": "string"
},
"name": {
"description": "Output only. Name of the resource. E.g.: `projects/myproject/locations/US/reservations/team1-prod/assignments/123`.",
"description": "Output only. Name of the resource. E.g.: `projects/myproject/locations/US/reservations/team1-prod/assignments/123`. For the assignment id, it must only contain lower case alphanumeric characters or dashes and the max length is 64 characters.",
"readOnly": true,
"type": "string"
},
@@ -866,8 +881,12 @@
"description": "Output only. For FAILED commitment plan, provides the reason of failure.",
"readOnly": true
},
"multiRegionAuxiliary": {
"description": "Applicable only for commitments located within one of the BigQuery multi-regions (US or EU). If set to true, this commitment is placed in the organization's secondary region which is designated for disaster recovery purposes. If false, this commitment is placed in the organization's default region.",
"type": "boolean"
},
"name": {
"description": "Output only. The resource name of the capacity commitment, e.g., `projects/myproject/locations/US/capacityCommitments/123`",
"description": "Output only. The resource name of the capacity commitment, e.g., `projects/myproject/locations/US/capacityCommitments/123` For the commitment id, it must only contain lower case alphanumeric characters or dashes.It must start with a letter and must not end with a dash. Its maximum length is 64 characters.",
"readOnly": true,
"type": "string"
},
@@ -922,8 +941,8 @@
],
"enumDescriptions": [
"Invalid state value.",
"Capacity commitment is pending provisioning. Pending capacity commitment does not contribute to the parent's slot_capacity.",
"Once slots are provisioned, capacity commitment becomes active. slot_count is added to the parent's slot_capacity.",
"Capacity commitment is pending provisioning. Pending capacity commitment does not contribute to the project's slot_capacity.",
"Once slots are provisioned, capacity commitment becomes active. slot_count is added to the project's slot_capacity.",
"Capacity commitment is failed to be activated by the backend."
],
"readOnly": true,
@@ -1021,6 +1040,11 @@
"description": "A reservation is a mechanism used to guarantee slots to users.",
"id": "Reservation",
"properties": {
"concurrency": {
"description": "Maximum number of queries that are allowed to run concurrently in this reservation. This is a soft limit due to asynchronous nature of the system and various optimizations for small queries. Default value is 0 which means that concurrency will be automatically set based on the reservation size.",
"format": "int64",
"type": "string"
},
"creationTime": {
"description": "Output only. Creation time of the reservation.",
"format": "google-datetime",
@@ -1028,15 +1052,19 @@
"type": "string"
},
"ignoreIdleSlots": {
"description": "If false, any query using this reservation will use idle slots from other reservations within the same admin project. If true, a query using this reservation will execute with the slot capacity specified above at most.",
"description": "If false, any query or pipeline job using this reservation will use idle slots from other reservations within the same admin project. If true, a query or pipeline job using this reservation will execute with the slot capacity specified in the slot_capacity field at most.",
"type": "boolean"
},
"multiRegionAuxiliary": {
"description": "Applicable only for reservations located within one of the BigQuery multi-regions (US or EU). If set to true, this reservation is placed in the organization's secondary region which is designated for disaster recovery purposes. If false, this reservation is placed in the organization's default region.",
"type": "boolean"
},
"name": {
"description": "The resource name of the reservation, e.g., `projects/*/locations/*/reservations/team1-prod`.",
"description": "The resource name of the reservation, e.g., `projects/*/locations/*/reservations/team1-prod`. For the reservation id, it must only contain lower case alphanumeric characters or dashes.It must start with a letter and must not end with a dash. Its maximum length is 64 characters.",
"type": "string"
},
"slotCapacity": {
"description": "Minimum slots available to this reservation. A slot is a unit of computational power in BigQuery, and serves as the unit of parallelism. Queries using this reservation might use more slots during runtime if ignore_idle_slots is set to false. If the new reservation's slot capacity exceed the parent's slot capacity or if total slot capacity of the new reservation and its siblings exceeds the parent's slot capacity, the request will fail with `google.rpc.Code.RESOURCE_EXHAUSTED`.",
"description": "Minimum slots available to this reservation. A slot is a unit of computational power in BigQuery, and serves as the unit of parallelism. Queries using this reservation might use more slots during runtime if ignore_idle_slots is set to false. If the new reservation's slot capacity exceed the project's slot capacity or if total slot capacity of the new reservation and its siblings exceeds the project's slot capacity, the request will fail with `google.rpc.Code.RESOURCE_EXHAUSTED`. NOTE: for reservations in US or EU multi-regions slot capacity constraints are checked separately for default and auxiliary regions. See multi_region_auxiliary flag for more details.",
"format": "int64",
"type": "string"
},

94
etc/api/bigqueryreservation/v1beta1/bigqueryreservation-api.json
View File

@@ -3,10 +3,10 @@
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/bigquery": {
"description": "View and manage your data in Google BigQuery"
"description": "View and manage your data in Google BigQuery and see the email address for your Google Account"
},
"https://www.googleapis.com/auth/cloud-platform": {
"description": "See, edit, configure, and delete your Google Cloud Platform data"
"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
}
}
}
@@ -228,6 +228,11 @@
"parent"
],
"parameters": {
"capacityCommitmentId": {
"description": "The optional capacity commitment ID. Capacity commitment name will be generated automatically if this field is empty. This field must only contain lower case alphanumeric characters or dashes. The first and last character cannot be a dash. Max length is 64 characters. NOTE: this ID won't be kept if the capacity commitment is split or merged.",
"location": "query",
"type": "string"
},
"enforceSingleAdminProjectPerOrg": {
"description": "If true, fail the request if another project in the organization has a capacity commitment.",
"location": "query",
@@ -262,6 +267,11 @@
"name"
],
"parameters": {
"force": {
"description": "Can be used to force delete commitments even if assignments exist. Deleting commitments with assignments may cause queries to fail if they no longer have access to slots.",
"location": "query",
"type": "boolean"
},
"name": {
"description": "Required. Resource name of the capacity commitment to delete. E.g., `projects/myproject/locations/US/capacityCommitments/123`",
"location": "path",
@@ -381,7 +391,7 @@
],
"parameters": {
"name": {
"description": "Output only. The resource name of the capacity commitment, e.g., `projects/myproject/locations/US/capacityCommitments/123`",
"description": "Output only. The resource name of the capacity commitment, e.g., `projects/myproject/locations/US/capacityCommitments/123` For the commitment id, it must only contain lower case alphanumeric characters or dashes.It must start with a letter and must not end with a dash. Its maximum length is 64 characters.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/capacityCommitments/[^/]+$",
"required": true,
@@ -456,7 +466,7 @@
"type": "string"
},
"reservationId": {
"description": "The reservation ID. This field must only contain lower case alphanumeric characters or dash. Max length is 64 characters.",
"description": "The reservation ID. It must only contain lower case alphanumeric characters or dashes.It must start with a letter and must not end with a dash. Its maximum length is 64 characters.",
"location": "query",
"type": "string"
}
@@ -577,7 +587,7 @@
],
"parameters": {
"name": {
"description": "The resource name of the reservation, e.g., `projects/*/locations/*/reservations/team1-prod`.",
"description": "The resource name of the reservation, e.g., `projects/*/locations/*/reservations/team1-prod`. For the reservation id, it must only contain lower case alphanumeric characters or dashes.It must start with a letter and must not end with a dash. Its maximum length is 64 characters.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/reservations/[^/]+$",
"required": true,
@@ -615,6 +625,11 @@
"parent"
],
"parameters": {
"assignmentId": {
"description": "The optional assignment ID. Assignment name will be generated automatically if this field is empty. This field must only contain lower case alphanumeric characters or dashes. Max length is 64 characters.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The parent resource name of the assignment E.g. `projects/myproject/locations/US/reservations/team1-prod`",
"location": "path",
@@ -726,6 +741,41 @@
"https://www.googleapis.com/auth/bigquery",
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"description": "Updates an existing assignment. Only the `priority` field can be updated.",
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reservations/{reservationsId}/assignments/{assignmentsId}",
"httpMethod": "PATCH",
"id": "bigqueryreservation.projects.locations.reservations.assignments.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Output only. Name of the resource. E.g.: `projects/myproject/locations/US/reservations/team1-prod/assignments/123`. For the assignment id, it must only contain lower case alphanumeric characters or dashes and the max length is 64 characters.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/reservations/[^/]+/assignments/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Standard field mask for the set of fields to be updated.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1beta1/{+name}",
"request": {
"$ref": "Assignment"
},
"response": {
"$ref": "Assignment"
},
"scopes": [
"https://www.googleapis.com/auth/bigquery",
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
@@ -736,11 +786,11 @@
}
}
},
"revision": "20210324",
"revision": "20220226",
"rootUrl": "https://bigqueryreservation.googleapis.com/",
"schemas": {
"Assignment": {
"description": "A Assignment allows a project to submit jobs of a certain type using slots from the specified reservation.",
"description": "An assignment allows a project to submit jobs of a certain type using slots from the specified reservation.",
"id": "Assignment",
"properties": {
"assignee": {
@@ -764,7 +814,7 @@
"type": "string"
},
"name": {
"description": "Output only. Name of the resource. E.g.: `projects/myproject/locations/US/reservations/team1-prod/assignments/123`.",
"description": "Output only. Name of the resource. E.g.: `projects/myproject/locations/US/reservations/team1-prod/assignments/123`. For the assignment id, it must only contain lower case alphanumeric characters or dashes and the max length is 64 characters.",
"readOnly": true,
"type": "string"
},
@@ -829,8 +879,12 @@
"description": "Output only. For FAILED commitment plan, provides the reason of failure.",
"readOnly": true
},
"multiRegionAuxiliary": {
"description": "Applicable only for commitments located within one of the BigQuery multi-regions (US or EU). If set to true, this commitment is placed in the organization's secondary region which is designated for disaster recovery purposes. If false, this commitment is placed in the organization's default region.",
"type": "boolean"
},
"name": {
"description": "Output only. The resource name of the capacity commitment, e.g., `projects/myproject/locations/US/capacityCommitments/123`",
"description": "Output only. The resource name of the capacity commitment, e.g., `projects/myproject/locations/US/capacityCommitments/123` For the commitment id, it must only contain lower case alphanumeric characters or dashes.It must start with a letter and must not end with a dash. Its maximum length is 64 characters.",
"readOnly": true,
"type": "string"
},
@@ -885,8 +939,8 @@
],
"enumDescriptions": [
"Invalid state value.",
"Capacity commitment is pending provisioning. Pending capacity commitment does not contribute to the parent's slot_capacity.",
"Once slots are provisioned, capacity commitment becomes active. slot_count is added to the parent's slot_capacity.",
"Capacity commitment is pending provisioning. Pending capacity commitment does not contribute to the project's slot_capacity.",
"Once slots are provisioned, capacity commitment becomes active. slot_count is added to the project's slot_capacity.",
"Capacity commitment is failed to be activated by the backend."
],
"readOnly": true,
@@ -984,6 +1038,11 @@
"description": "A reservation is a mechanism used to guarantee slots to users.",
"id": "Reservation",
"properties": {
"concurrency": {
"description": "Maximum number of queries that are allowed to run concurrently in this reservation. This is a soft limit due to asynchronous nature of the system and various optimizations for small queries. Default value is 0 which means that concurrency will be automatically set based on the reservation size.",
"format": "int64",
"type": "string"
},
"creationTime": {
"description": "Output only. Creation time of the reservation.",
"format": "google-datetime",
@@ -991,20 +1050,19 @@
"type": "string"
},
"ignoreIdleSlots": {
"description": "If false, any query using this reservation will use idle slots from other reservations within the same admin project. If true, a query using this reservation will execute with the slot capacity specified above at most.",
"description": "If false, any query or pipeline job using this reservation will use idle slots from other reservations within the same admin project. If true, a query or pipeline job using this reservation will execute with the slot capacity specified in the slot_capacity field at most.",
"type": "boolean"
},
"maxConcurrency": {
"description": "Maximum number of queries that are allowed to run concurrently in this reservation. Default value is 0 which means that maximum concurrency will be automatically set based on the reservation size.",
"format": "int64",
"type": "string"
"multiRegionAuxiliary": {
"description": "Applicable only for reservations located within one of the BigQuery multi-regions (US or EU). If set to true, this reservation is placed in the organization's secondary region which is designated for disaster recovery purposes. If false, this reservation is placed in the organization's default region.",
"type": "boolean"
},
"name": {
"description": "The resource name of the reservation, e.g., `projects/*/locations/*/reservations/team1-prod`.",
"description": "The resource name of the reservation, e.g., `projects/*/locations/*/reservations/team1-prod`. For the reservation id, it must only contain lower case alphanumeric characters or dashes.It must start with a letter and must not end with a dash. Its maximum length is 64 characters.",
"type": "string"
},
"slotCapacity": {
"description": "Minimum slots available to this reservation. A slot is a unit of computational power in BigQuery, and serves as the unit of parallelism. Queries using this reservation might use more slots during runtime if ignore_idle_slots is set to false. If the new reservation's slot capacity exceed the parent's slot capacity or if total slot capacity of the new reservation and its siblings exceeds the parent's slot capacity, the request will fail with `google.rpc.Code.RESOURCE_EXHAUSTED`.",
"description": "Minimum slots available to this reservation. A slot is a unit of computational power in BigQuery, and serves as the unit of parallelism. Queries using this reservation might use more slots during runtime if ignore_idle_slots is set to false. If the new reservation's slot capacity exceed the project's slot capacity or if total slot capacity of the new reservation and its siblings exceeds the project's slot capacity, the request will fail with `google.rpc.Code.RESOURCE_EXHAUSTED`. NOTE: for reservations in US or EU multi-regions slot capacity constraints are checked separately for default and auxiliary regions. See multi_region_auxiliary flag for more details.",
"format": "int64",
"type": "string"
},

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

@@ -24,10 +24,10 @@
"description": "Administer your Cloud Bigtable tables"
},
"https://www.googleapis.com/auth/cloud-platform": {
"description": "View and manage your data across Google Cloud Platform services"
"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
},
"https://www.googleapis.com/auth/cloud-platform.read-only": {
"description": "View your data across Google Cloud Platform services"
"description": "View your data across Google Cloud services and see the email address of your Google Account"
}
}
}
@@ -286,7 +286,7 @@
"instances": {
"methods": {
"create": {
"description": "Create an instance within a project.",
"description": "Create an instance within a project. Note that exactly one of Cluster.serve_nodes and Cluster.cluster_config.cluster_autoscaling_config can be set. If serve_nodes is set to non-zero, then the cluster is manually scaled. If cluster_config.cluster_autoscaling_config is non-empty, then autoscaling is enabled.",
"flatPath": "v2/projects/{projectsId}/instances",
"httpMethod": "POST",
"id": "bigtableadmin.projects.instances.create",
@@ -789,7 +789,7 @@
"clusters": {
"methods": {
"create": {
"description": "Creates a cluster within an instance.",
"description": "Creates a cluster within an instance. Note that exactly one of Cluster.serve_nodes and Cluster.cluster_config.cluster_autoscaling_config can be set. If serve_nodes is set to non-zero, then the cluster is manually scaled. If cluster_config.cluster_autoscaling_config is non-empty, then autoscaling is enabled.",
"flatPath": "v2/projects/{projectsId}/instances/{instancesId}/clusters",
"httpMethod": "POST",
"id": "bigtableadmin.projects.instances.clusters.create",
@@ -923,8 +923,47 @@
"https://www.googleapis.com/auth/cloud-platform.read-only"
]
},
"partialUpdateCluster": {
"description": "Partially updates a cluster within a project. This method is the preferred way to update a Cluster. To enable and update autoscaling, set cluster_config.cluster_autoscaling_config. When autoscaling is enabled, serve_nodes is treated as an OUTPUT_ONLY field, meaning that updates to it are ignored. Note that an update cannot simultaneously set serve_nodes to non-zero and cluster_config.cluster_autoscaling_config to non-empty, and also specify both in the update_mask. To disable autoscaling, clear cluster_config.cluster_autoscaling_config, and explicitly set a serve_node count via the update_mask.",
"flatPath": "v2/projects/{projectsId}/instances/{instancesId}/clusters/{clustersId}",
"httpMethod": "PATCH",
"id": "bigtableadmin.projects.instances.clusters.partialUpdateCluster",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The unique name of the cluster. Values are of the form `projects/{project}/instances/{instance}/clusters/a-z*`.",
"location": "path",
"pattern": "^projects/[^/]+/instances/[^/]+/clusters/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Required. The subset of Cluster fields which should be replaced.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v2/{+name}",
"request": {
"$ref": "Cluster"
},
"response": {
"$ref": "Operation"
},
"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"
]
},
"update": {
"description": "Updates a cluster within an instance.",
"description": "Updates a cluster within an instance. Note that UpdateCluster does not support updating cluster_config.cluster_autoscaling_config. In order to update it, you must use PartialUpdateCluster.",
"flatPath": "v2/projects/{projectsId}/instances/{instancesId}/clusters/{clustersId}",
"httpMethod": "PUT",
"id": "bigtableadmin.projects.instances.clusters.update",
@@ -1433,7 +1472,7 @@
"Only populates `name`.",
"Only populates `name` and fields related to the table's schema.",
"Only populates `name` and fields related to the table's replication state.",
"Only populates 'name' and fields related to the table's encryption state.",
"Only populates `name` and fields related to the table's encryption state.",
"Populates all fields."
],
"location": "query",
@@ -1513,7 +1552,7 @@
"type": "string"
},
"view": {
"description": "The view to be applied to the returned tables' fields. Only NAME_ONLY view (default) and REPLICATION_VIEW are supported.",
"description": "The view to be applied to the returned tables' fields. Only NAME_ONLY view (default), REPLICATION_VIEW and ENCRYPTION_VIEW are supported.",
"enum": [
"VIEW_UNSPECIFIED",
"NAME_ONLY",
@@ -1527,7 +1566,7 @@
"Only populates `name`.",
"Only populates `name` and fields related to the table's schema.",
"Only populates `name` and fields related to the table's replication state.",
"Only populates 'name' and fields related to the table's encryption state.",
"Only populates `name` and fields related to the table's encryption state.",
"Populates all fields."
],
"location": "query",
@@ -1580,7 +1619,7 @@
]
},
"restore": {
"description": "Create a new table by restoring from a completed backup. The new table must be in the same instance as the instance containing the backup. The returned table long-running operation can be used to track the progress of the operation, and to cancel it. The metadata field type is RestoreTableMetadata. The response type is Table, if successful.",
"description": "Create a new table by restoring from a completed backup. The new table must be in the same project as the instance containing the backup. The returned table long-running operation can be used to track the progress of the operation, and to cancel it. The metadata field type is RestoreTableMetadata. The response type is Table, if successful.",
"flatPath": "v2/projects/{projectsId}/instances/{instancesId}/tables:restore",
"httpMethod": "POST",
"id": "bigtableadmin.projects.instances.tables.restore",
@@ -1589,7 +1628,7 @@
],
"parameters": {
"parent": {
"description": "Required. The name of the instance in which to create the restored table. This instance must be the parent of the source backup. Values are of the form `projects//instances/`.",
"description": "Required. The name of the instance in which to create the restored table. This instance must be in the same project as the source backup. Values are of the form `projects//instances/`.",
"location": "path",
"pattern": "^projects/[^/]+/instances/[^/]+$",
"required": true,
@@ -1722,7 +1761,7 @@
],
"parameters": {
"filter": {
"description": "The standard list filter.",
"description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like \"displayName=tokyo\", and is documented in more detail in [AIP-160](https://google.aip.dev/160).",
"location": "query",
"type": "string"
},
@@ -1734,13 +1773,13 @@
"type": "string"
},
"pageSize": {
"description": "The standard list page size.",
"description": "The maximum number of results to return. If not set, the service selects a default.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The standard list page token.",
"description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.",
"location": "query",
"type": "string"
}
@@ -1764,7 +1803,7 @@
}
}
},
"revision": "20210323",
"revision": "20220222",
"rootUrl": "https://bigtableadmin.googleapis.com/",
"schemas": {
"AppProfile": {
@@ -1842,6 +1881,35 @@
},
"type": "object"
},
"AutoscalingLimits": {
"description": "Limits for the number of nodes a Cluster can autoscale up/down to.",
"id": "AutoscalingLimits",
"properties": {
"maxServeNodes": {
"description": "Required. Maximum number of nodes to scale up to.",
"format": "int32",
"type": "integer"
},
"minServeNodes": {
"description": "Required. Minimum number of nodes to scale down to.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"AutoscalingTargets": {
"description": "The Autoscaling targets for a Cluster. These determine the recommended nodes.",
"id": "AutoscalingTargets",
"properties": {
"cpuUtilizationPercent": {
"description": "The cpu utilization that the Autoscaler should be trying to achieve. This number is on a scale from 0 (no utilization) to 100 (total utilization), and is limited between 10 and 80.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"Backup": {
"description": "A backup of a Cloud Bigtable table.",
"id": "Backup",
@@ -1930,22 +1998,22 @@
"type": "object"
},
"Binding": {
"description": "Associates `members` with a `role`.",
"description": "Associates `members`, or principals, with a `role`.",
"id": "Binding",
"properties": {
"condition": {
"$ref": "Expr",
"description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)."
"description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)."
},
"members": {
"description": "Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ",
"description": "Specifies the principals requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ",
"items": {
"type": "string"
},
"type": "array"
},
"role": {
"description": "Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.",
"description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.",
"type": "string"
}
},
@@ -1977,6 +2045,10 @@
"description": "A resizable group of nodes in a particular cloud location, capable of serving all Tables in the parent Instance.",
"id": "Cluster",
"properties": {
"clusterConfig": {
"$ref": "ClusterConfig",
"description": "Configuration for this cluster."
},
"defaultStorageType": {
"description": "Immutable. The type of storage used by this cluster to serve its parent instance's tables, unless explicitly overridden.",
"enum": [
@@ -2004,7 +2076,7 @@
"type": "string"
},
"serveNodes": {
"description": "Required. The number of nodes allocated to this cluster. More nodes enable higher throughput and more consistent performance.",
"description": "The number of nodes allocated to this cluster. More nodes enable higher throughput and more consistent performance.",
"format": "int32",
"type": "integer"
},
@@ -2030,6 +2102,32 @@
},
"type": "object"
},
"ClusterAutoscalingConfig": {
"description": "Autoscaling config for a cluster.",
"id": "ClusterAutoscalingConfig",
"properties": {
"autoscalingLimits": {
"$ref": "AutoscalingLimits",
"description": "Required. Autoscaling limits for this cluster."
},
"autoscalingTargets": {
"$ref": "AutoscalingTargets",
"description": "Required. Autoscaling targets for this cluster."
}
},
"type": "object"
},
"ClusterConfig": {
"description": "Configuration for a cluster.",
"id": "ClusterConfig",
"properties": {
"clusterAutoscalingConfig": {
"$ref": "ClusterAutoscalingConfig",
"description": "Autoscaling configuration for this cluster."
}
},
"type": "object"
},
"ClusterState": {
"description": "The state of a table's data in a particular cluster.",
"id": "ClusterState",
@@ -2306,34 +2404,6 @@
},
"type": "object"
},
"FailureTrace": {
"description": "Added to the error payload.",
"id": "FailureTrace",
"properties": {
"frames": {
"items": {
"$ref": "Frame"
},
"type": "array"
}
},
"type": "object"
},
"Frame": {
"id": "Frame",
"properties": {
"targetName": {
"type": "string"
},
"workflowGuid": {
"type": "string"
},
"zoneId": {
"type": "string"
}
},
"type": "object"
},
"GcRule": {
"description": "Rule for determining which cells to delete during garbage collection.",
"id": "GcRule",
@@ -2392,7 +2462,7 @@
"id": "GetPolicyOptions",
"properties": {
"requestedPolicyVersion": {
"description": "Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
"format": "int32",
"type": "integer"
}
@@ -2403,6 +2473,12 @@
"description": "A collection of Bigtable Tables and the resources that serve them. All tables in an instance are served from all Clusters in the instance.",
"id": "Instance",
"properties": {
"createTime": {
"description": "Output only. A server-assigned timestamp representing when this Instance was created. For instances created before this field was added (August 2021), this value is `seconds: 0, nanos: 1`.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"displayName": {
"description": "Required. The descriptive name for this instance as it appears in UIs. Can be changed at any time, but should be kept globally unique to avoid confusion.",
"type": "string"
@@ -2685,7 +2761,15 @@
"MultiClusterRoutingUseAny": {
"description": "Read/write requests are routed to the nearest cluster in the instance, and will fail over to the nearest cluster that is available in the event of transient errors or delays. Clusters in a region are considered equidistant. Choosing this option sacrifices read-your-writes consistency to improve availability.",
"id": "MultiClusterRoutingUseAny",
"properties": {},
"properties": {
"clusterIds": {
"description": "The set of clusters to route to. The order is ignored; clusters will be tried in order of distance. If left empty, all clusters are eligible.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Operation": {
@@ -2760,6 +2844,43 @@
},
"type": "object"
},
"PartialUpdateClusterMetadata": {
"description": "The metadata for the Operation returned by PartialUpdateCluster.",
"id": "PartialUpdateClusterMetadata",
"properties": {
"finishTime": {
"description": "The time at which the operation failed or was completed successfully.",
"format": "google-datetime",
"type": "string"
},
"originalRequest": {
"$ref": "PartialUpdateClusterRequest",
"description": "The original request for PartialUpdateCluster."
},
"requestTime": {
"description": "The time at which the original request was received.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"PartialUpdateClusterRequest": {
"description": "Request message for BigtableInstanceAdmin.PartialUpdateCluster.",
"id": "PartialUpdateClusterRequest",
"properties": {
"cluster": {
"$ref": "Cluster",
"description": "Required. The Cluster which contains the partial updates to be applied, subject to the update_mask."
},
"updateMask": {
"description": "Required. The subset of Cluster fields which should be replaced.",
"format": "google-fieldmask",
"type": "string"
}
},
"type": "object"
},
"PartialUpdateInstanceRequest": {
"description": "Request message for BigtableInstanceAdmin.PartialUpdateInstance.",
"id": "PartialUpdateInstanceRequest",
@@ -2777,7 +2898,7 @@
"type": "object"
},
"Policy": {
"description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).",
"description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).",
"id": "Policy",
"properties": {
"auditConfigs": {
@@ -2788,7 +2909,7 @@
"type": "array"
},
"bindings": {
"description": "Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.",
"description": "Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.",
"items": {
"$ref": "Binding"
},

42
etc/api/billingbudgets/v1/billingbudgets-api.json
View File

@@ -6,7 +6,7 @@
"description": "View and manage your Google Cloud Platform billing accounts"
},
"https://www.googleapis.com/auth/cloud-platform": {
"description": "See, edit, configure, and delete your Google Cloud Platform data"
"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
}
}
}
@@ -270,7 +270,7 @@
}
}
},
"revision": "20210326",
"revision": "20220227",
"rootUrl": "https://billingbudgets.googleapis.com/",
"schemas": {
"GoogleCloudBillingBudgetsV1Budget": {
@@ -283,14 +283,14 @@
},
"budgetFilter": {
"$ref": "GoogleCloudBillingBudgetsV1Filter",
"description": "Optional. Filters that define which resources are used to compute the actual spend against the budget."
"description": "Optional. Filters that define which resources are used to compute the actual spend against the budget amount, such as projects, services, and the budget's time period, as well as other filters."
},
"displayName": {
"description": "User data for display name in UI. The name must be less than or equal to 60 characters.",
"type": "string"
},
"etag": {
"description": "Optional. Etag to validate that the object is unchanged for a read-modify-write operation. An empty etag will cause an update to overwrite other changes.",
"description": "Optional. Etag to validate that the object is unchanged for a read-modify-write operation. An empty etag causes an update to overwrite other changes.",
"type": "string"
},
"name": {
@@ -303,7 +303,7 @@
"description": "Optional. Rules to apply to notifications sent based on budget spend and thresholds."
},
"thresholdRules": {
"description": "Optional. Rules that trigger alerts (notifications of thresholds being crossed) when spend exceeds the specified percentages of the budget.",
"description": "Optional. Rules that trigger alerts (notifications of thresholds being crossed) when spend exceeds the specified percentages of the budget. Optional for `pubsubTopic` notifications. Required if using email notifications.",
"items": {
"$ref": "GoogleCloudBillingBudgetsV1ThresholdRule"
},
@@ -318,7 +318,7 @@
"properties": {
"lastPeriodAmount": {
"$ref": "GoogleCloudBillingBudgetsV1LastPeriodAmount",
"description": "Use the last period's actual spend as the budget for the present period. Cannot be set in combination with Filter.custom_period."
"description": "Use the last period's actual spend as the budget for the present period. LastPeriodAmount can only be set when the budget's time period is a Filter.calendar_period. It cannot be set in combination with Filter.custom_period."
},
"specifiedAmount": {
"$ref": "GoogleTypeMoney",
@@ -347,7 +347,7 @@
"id": "GoogleCloudBillingBudgetsV1Filter",
"properties": {
"calendarPeriod": {
"description": "Optional. Specifies to track usage for recurring calendar period. E.g. Assume that CalendarPeriod.QUARTER is set. The budget will track usage from April 1 to June 30, when current calendar month is April, May, June. After that, it will track usage from July 1 to September 30 when current calendar month is July, August, September, and so on.",
"description": "Optional. Specifies to track usage for recurring calendar period. For example, assume that CalendarPeriod.QUARTER is set. The budget tracks usage from April 1 to June 30, when the current calendar month is April, May, June. After that, it tracks usage from July 1 to September 30 when the current calendar month is July, August, September, so on.",
"enum": [
"CALENDAR_PERIOD_UNSPECIFIED",
"MONTH",
@@ -355,7 +355,7 @@
"YEAR"
],
"enumDescriptions": [
"",
"Calendar period is unset. This is the default if the budget is for a custom time period (CustomPeriod).",
"A month. Month starts on the first day of each month, such as January 1, February 1, March 1, and so on.",
"A quarter. Quarters start on dates January 1, April 1, July 1, and October 1 of each year.",
"A year. Year starts on January 1."
@@ -363,7 +363,7 @@
"type": "string"
},
"creditTypes": {
"description": "Optional. If Filter.credit_types_treatment is INCLUDE_SPECIFIED_CREDITS, this is a list of credit types to be subtracted from gross cost to determine the spend for threshold calculations. If Filter.credit_types_treatment is **not** INCLUDE_SPECIFIED_CREDITS, this field must be empty. See [a list of acceptable credit type values](https://cloud.google.com/billing/docs/how-to/export-data-bigquery-tables#credits-type).",
"description": "Optional. If Filter.credit_types_treatment is INCLUDE_SPECIFIED_CREDITS, this is a list of credit types to be subtracted from gross cost to determine the spend for threshold calculations. See [a list of acceptable credit type values](https://cloud.google.com/billing/docs/how-to/export-data-bigquery-tables#credits-type). If Filter.credit_types_treatment is **not** INCLUDE_SPECIFIED_CREDITS, this field must be empty.",
"items": {
"type": "string"
},
@@ -381,13 +381,13 @@
"",
"All types of credit are subtracted from the gross cost to determine the spend for threshold calculations.",
"All types of credit are added to the net cost to determine the spend for threshold calculations.",
"Credit types specified in the credit_types field are subtracted from the gross cost to determine the spend for threshold calculations."
"[Credit types](https://cloud.google.com/billing/docs/how-to/export-data-bigquery-tables#credits-type) specified in the credit_types field are subtracted from the gross cost to determine the spend for threshold calculations."
],
"type": "string"
},
"customPeriod": {
"$ref": "GoogleCloudBillingBudgetsV1CustomPeriod",
"description": "Optional. Specifies to track usage from any start date (required) to any end date (optional)."
"description": "Optional. Specifies to track usage from any start date (required) to any end date (optional). This time period is static, it does not recur."
},
"labels": {
"additionalProperties": {
@@ -396,25 +396,25 @@
},
"type": "array"
},
"description": "Optional. A single label and value pair specifying that usage from only this set of labeled resources should be included in the budget. Currently, multiple entries or multiple values per entry are not allowed. If omitted, the report will include all labeled and unlabeled usage.",
"description": "Optional. A single label and value pair specifying that usage from only this set of labeled resources should be included in the budget. If omitted, the report includes all labeled and unlabeled usage. An object containing a single `\"key\": value` pair. Example: `{ \"name\": \"wrench\" }`. _Currently, multiple entries or multiple values per entry are not allowed._",
"type": "object"
},
"projects": {
"description": "Optional. A set of projects of the form `projects/{project}`, specifying that usage from only this set of projects should be included in the budget. If omitted, the report will include all usage for the billing account, regardless of which project the usage occurred on. Only zero or one project can be specified currently.",
"description": "Optional. A set of projects of the form `projects/{project}`, specifying that usage from only this set of projects should be included in the budget. If omitted, the report includes all usage for the billing account, regardless of which project the usage occurred on. Only zero or one project can be specified currently.",
"items": {
"type": "string"
},
"type": "array"
},
"services": {
"description": "Optional. A set of services of the form `services/{service_id}`, specifying that usage from only this set of services should be included in the budget. If omitted, the report will include usage for all the services. The service names are available through the Catalog API: https://cloud.google.com/billing/v1/how-tos/catalog-api.",
"description": "Optional. A set of services of the form `services/{service_id}`, specifying that usage from only this set of services should be included in the budget. If omitted, the report includes usage for all the services. The service names are available through the Catalog API: https://cloud.google.com/billing/v1/how-tos/catalog-api.",
"items": {
"type": "string"
},
"type": "array"
},
"subaccounts": {
"description": "Optional. A set of subaccounts of the form `billingAccounts/{account_id}`, specifying that usage from only this set of subaccounts should be included in the budget. If a subaccount is set to the name of the parent account, usage from the parent account will be included. If the field is omitted, the report will include usage from the parent account and all subaccounts, if they exist.",
"description": "Optional. A set of subaccounts of the form `billingAccounts/{account_id}`, specifying that usage from only this set of subaccounts should be included in the budget. If a subaccount is set to the name of the parent account, usage from the parent account is included. If the field is omitted, the report includes usage from the parent account and all subaccounts, if they exist.",
"items": {
"type": "string"
},
@@ -424,7 +424,7 @@
"type": "object"
},
"GoogleCloudBillingBudgetsV1LastPeriodAmount": {
"description": "Describes a budget amount targeted to last period's spend. At this time, the amount is automatically 100% of last period's spend; that is, there are no other options yet. Future configuration will be described here (for example, configuring a percentage of last period's spend).",
"description": "Describes a budget amount targeted to the last Filter.calendar_period spend. At this time, the amount is automatically 100% of the last calendar period's spend; that is, there are no other options yet. LastPeriodAmount cannot be set for a budget configured with a Filter.custom_period.",
"id": "GoogleCloudBillingBudgetsV1LastPeriodAmount",
"properties": {},
"type": "object"
@@ -456,14 +456,14 @@
"type": "boolean"
},
"monitoringNotificationChannels": {
"description": "Optional. Targets to send notifications to when a threshold is exceeded. This is in addition to default recipients who have billing account IAM roles. The value is the full REST resource name of a monitoring notification channel with the form `projects/{project_id}/notificationChannels/{channel_id}`. A maximum of 5 channels are allowed. See https://cloud.google.com/billing/docs/how-to/budgets-notification-recipients for more details.",
"description": "Optional. Email targets to send notifications to when a threshold is exceeded. This is in addition to the `DefaultIamRecipients` who receive alert emails based on their billing account IAM role. The value is the full REST resource name of a Cloud Monitoring email notification channel with the form `projects/{project_id}/notificationChannels/{channel_id}`. A maximum of 5 email notifications are allowed. To customize budget alert email recipients with monitoring notification channels, you _must create the monitoring notification channels before you link them to a budget_. For guidance on setting up notification channels to use with budgets, see [Customize budget alert email recipients](https://cloud.google.com/billing/docs/how-to/budgets-notification-recipients). For Cloud Billing budget alerts, you _must use email notification channels_. The other types of notification channels are _not_ supported, such as Slack, SMS, or PagerDuty. If you want to [send budget notifications to Slack](https://cloud.google.com/billing/docs/how-to/notify#send_notifications_to_slack), use a pubsubTopic and configure [programmatic notifications](https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications).",
"items": {
"type": "string"
},
"type": "array"
},
"pubsubTopic": {
"description": "Optional. The name of the Pub/Sub topic where budget related messages will be published, in the form `projects/{project_id}/topics/{topic_id}`. Updates are sent at regular intervals to the topic. The topic needs to be created before the budget is created; see https://cloud.google.com/billing/docs/how-to/budgets#manage-notifications for more details. Caller is expected to have `pubsub.topics.setIamPolicy` permission on the topic when it's set for a budget, otherwise, the API call will fail with PERMISSION_DENIED. See https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications for more details on Pub/Sub roles and permissions.",
"description": "Optional. The name of the Pub/Sub topic where budget-related messages are published, in the form `projects/{project_id}/topics/{topic_id}`. Updates are sent to the topic at regular intervals; the timing of the updates is not dependent on the [threshold rules](#thresholdrule) you've set. Note that if you want your [Pub/Sub JSON object](https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification_format) to contain data for `alertThresholdExceeded`, you need at least one [alert threshold rule](#thresholdrule). When you set threshold rules, you must also enable at least one of the email notification options, either using the default IAM recipients or Cloud Monitoring email notification channels. To use Pub/Sub topics with budgets, you must do the following: 1. Create the Pub/Sub topic before connecting it to your budget. For guidance, see [Manage programmatic budget alert notifications](https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications). 2. Grant the API caller the `pubsub.topics.setIamPolicy` permission on the Pub/Sub topic. If not set, the API call fails with PERMISSION_DENIED. For additional details on Pub/Sub roles and permissions, see [Permissions required for this task](https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#permissions_required_for_this_task).",
"type": "string"
},
"schemaVersion": {
@@ -474,7 +474,7 @@
"type": "object"
},
"GoogleCloudBillingBudgetsV1ThresholdRule": {
"description": "ThresholdRule contains a definition of a threshold which triggers an alert (a notification of a threshold being crossed) to be sent when spend goes above the specified amount. Alerts are automatically e-mailed to users with the Billing Account Administrator role or the Billing Account User role. The thresholds here have no effect on notifications sent to anything configured under `Budget.all_updates_rule`.",
"description": "ThresholdRule contains the definition of a threshold. Threshold rules define the triggering events used to generate a budget notification email. When a threshold is crossed (spend exceeds the specified percentages of the budget), budget alert emails are sent to the email recipients you specify in the [NotificationsRule](#notificationsrule). Threshold rules also affect the fields included in the [JSON data object](https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification_format) sent to a Pub/Sub topic. Threshold rules are _required_ if using email notifications. Threshold rules are _optional_ if only setting a [`pubsubTopic` NotificationsRule](#NotificationsRule), unless you want your JSON data object to include data about the thresholds you set. For more information, see [set budget threshold rules and actions](https://cloud.google.com/billing/docs/how-to/budgets#budget-actions).",
"id": "GoogleCloudBillingBudgetsV1ThresholdRule",
"properties": {
"spendBasis": {
@@ -487,7 +487,7 @@
"enumDescriptions": [
"Unspecified threshold basis.",
"Use current spend as the basis for comparison against the threshold.",
"Use forecasted spend for the period as the basis for comparison against the threshold. Cannot be set in combination with Filter.custom_period."
"Use forecasted spend for the period as the basis for comparison against the threshold. FORECASTED_SPEND can only be set when the budget's time period is a Filter.calendar_period. It cannot be set in combination with Filter.custom_period."
],
"type": "string"
},
@@ -506,7 +506,7 @@
"type": "object"
},
"GoogleTypeDate": {
"description": "Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.",
"description": "Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day, with a zero year (e.g., an anniversary) * A year on its own, with a zero month and a zero day * A year and month, with a zero day (e.g., a credit card expiration date) Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp",
"id": "GoogleTypeDate",
"properties": {
"day": {

32
etc/api/billingbudgets/v1beta1/billingbudgets-api.json
View File

@@ -6,7 +6,7 @@
"description": "View and manage your Google Cloud Platform billing accounts"
},
"https://www.googleapis.com/auth/cloud-platform": {
"description": "See, edit, configure, and delete your Google Cloud Platform data"
"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
}
}
}
@@ -113,7 +113,7 @@
"budgets": {
"methods": {
"create": {
"description": "Creates a new budget. See Quotas and limits for more information on the limits of the number of budgets you can create.",
"description": "Creates a new budget. See [Quotas and limits](https://cloud.google.com/billing/quotas) for more information on the limits of the number of budgets you can create.",
"flatPath": "v1beta1/billingAccounts/{billingAccountsId}/budgets",
"httpMethod": "POST",
"id": "billingbudgets.billingAccounts.budgets.create",
@@ -264,7 +264,7 @@
}
}
},
"revision": "20210326",
"revision": "20220227",
"rootUrl": "https://billingbudgets.googleapis.com/",
"schemas": {
"GoogleCloudBillingBudgetsV1beta1AllUpdatesRule": {
@@ -307,7 +307,7 @@
},
"budgetFilter": {
"$ref": "GoogleCloudBillingBudgetsV1beta1Filter",
"description": "Optional. Filters that define which resources are used to compute the actual spend against the budget."
"description": "Optional. Filters that define which resources are used to compute the actual spend against the budget amount, such as projects, services, and the budget's time period, as well as other filters."
},
"displayName": {
"description": "User data for display name in UI. Validation: <= 60 chars.",
@@ -323,7 +323,7 @@
"type": "string"
},
"thresholdRules": {
"description": "Optional. Rules that trigger alerts (notifications of thresholds being crossed) when spend exceeds the specified percentages of the budget.",
"description": "Optional. Rules that trigger alerts (notifications of thresholds being crossed) when spend exceeds the specified percentages of the budget. Optional for `pubsubTopic` notifications. Required if using email notifications.",
"items": {
"$ref": "GoogleCloudBillingBudgetsV1beta1ThresholdRule"
},
@@ -338,7 +338,7 @@
"properties": {
"lastPeriodAmount": {
"$ref": "GoogleCloudBillingBudgetsV1beta1LastPeriodAmount",
"description": "Use the last period's actual spend as the budget for the present period. Cannot be set in combination with Filter.custom_period."
"description": "Use the last period's actual spend as the budget for the present period. LastPeriodAmount can only be set when the budget's time period is a Filter.calendar_period. It cannot be set in combination with Filter.custom_period."
},
"specifiedAmount": {
"$ref": "GoogleTypeMoney",
@@ -378,7 +378,7 @@
"id": "GoogleCloudBillingBudgetsV1beta1Filter",
"properties": {
"calendarPeriod": {
"description": "Optional. Specifies to track usage for recurring calendar period. E.g. Assume that CalendarPeriod.QUARTER is set. The budget will track usage from April 1 to June 30, when current calendar month is April, May, June. After that, it will track usage from July 1 to September 30 when current calendar month is July, August, September, and so on.",
"description": "Optional. Specifies to track usage for recurring calendar period. For example, assume that CalendarPeriod.QUARTER is set. The budget will track usage from April 1 to June 30, when the current calendar month is April, May, June. After that, it will track usage from July 1 to September 30 when the current calendar month is July, August, September, so on.",
"enum": [
"CALENDAR_PERIOD_UNSPECIFIED",
"MONTH",
@@ -386,7 +386,7 @@
"YEAR"
],
"enumDescriptions": [
"",
"Calendar period is unset. This is the default if the budget is for a custom time period (CustomPeriod).",
"A month. Month starts on the first day of each month, such as January 1, February 1, March 1, and so on.",
"A quarter. Quarters start on dates January 1, April 1, July 1, and October 1 of each year.",
"A year. Year starts on January 1."
@@ -394,7 +394,7 @@
"type": "string"
},
"creditTypes": {
"description": "Optional. If Filter.credit_types_treatment is INCLUDE_SPECIFIED_CREDITS, this is a list of credit types to be subtracted from gross cost to determine the spend for threshold calculations. If Filter.credit_types_treatment is **not** INCLUDE_SPECIFIED_CREDITS, this field must be empty. See [a list of acceptable credit type values](https://cloud.google.com/billing/docs/how-to/export-data-bigquery-tables#credits-type).",
"description": "Optional. If Filter.credit_types_treatment is INCLUDE_SPECIFIED_CREDITS, this is a list of credit types to be subtracted from gross cost to determine the spend for threshold calculations. See [a list of acceptable credit type values](https://cloud.google.com/billing/docs/how-to/export-data-bigquery-tables#credits-type). If Filter.credit_types_treatment is **not** INCLUDE_SPECIFIED_CREDITS, this field must be empty.",
"items": {
"type": "string"
},
@@ -412,13 +412,13 @@
"",
"All types of credit are subtracted from the gross cost to determine the spend for threshold calculations.",
"All types of credit are added to the net cost to determine the spend for threshold calculations.",
"Credit types specified in the credit_types field are subtracted from the gross cost to determine the spend for threshold calculations."
"[Credit types](https://cloud.google.com/billing/docs/how-to/export-data-bigquery-tables#credits-type) specified in the credit_types field are subtracted from the gross cost to determine the spend for threshold calculations."
],
"type": "string"
},
"customPeriod": {
"$ref": "GoogleCloudBillingBudgetsV1beta1CustomPeriod",
"description": "Optional. Specifies to track usage from any start date (required) to any end date (optional)."
"description": "Optional. Specifies to track usage from any start date (required) to any end date (optional). This time period is static, it does not recur."
},
"labels": {
"additionalProperties": {
@@ -427,7 +427,7 @@
},
"type": "array"
},
"description": "Optional. A single label and value pair specifying that usage from only this set of labeled resources should be included in the budget. Currently, multiple entries or multiple values per entry are not allowed. If omitted, the report will include all labeled and unlabeled usage.",
"description": "Optional. A single label and value pair specifying that usage from only this set of labeled resources should be included in the budget. If omitted, the report will include all labeled and unlabeled usage. An object containing a single `\"key\": value` pair. Example: `{ \"name\": \"wrench\" }`. _Currently, multiple entries or multiple values per entry are not allowed._",
"type": "object"
},
"projects": {
@@ -455,7 +455,7 @@
"type": "object"
},
"GoogleCloudBillingBudgetsV1beta1LastPeriodAmount": {
"description": "Describes a budget amount targeted to last period's spend. At this time, the amount is automatically 100% of last period's spend; that is, there are no other options yet. Future configuration will be described here (for example, configuring a percentage of last period's spend).",
"description": "Describes a budget amount targeted to the last Filter.calendar_period spend. At this time, the amount is automatically 100% of the last calendar period's spend; that is, there are no other options yet. Future configuration options will be described here (for example, configuring a percentage of last period's spend). LastPeriodAmount cannot be set for a budget configured with a Filter.custom_period.",
"id": "GoogleCloudBillingBudgetsV1beta1LastPeriodAmount",
"properties": {},
"type": "object"
@@ -479,7 +479,7 @@
"type": "object"
},
"GoogleCloudBillingBudgetsV1beta1ThresholdRule": {
"description": "ThresholdRule contains a definition of a threshold which triggers an alert (a notification of a threshold being crossed) to be sent when spend goes above the specified amount. Alerts are automatically e-mailed to users with the Billing Account Administrator role or the Billing Account User role. The thresholds here have no effect on notifications sent to anything configured under `Budget.all_updates_rule`.",
"description": "ThresholdRule contains the definition of a threshold. Threshold rules define the triggering events used to generate a budget notification email. When a threshold is crossed (spend exceeds the specified percentages of the budget), budget alert emails are sent to the email recipients you specify in the [NotificationsRule](#notificationsrule). Threshold rules also affect the fields included in the [JSON data object](https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification_format) sent to a Pub/Sub topic. Threshold rules are _required_ if using email notifications. Threshold rules are _optional_ if only setting a [`pubsubTopic` NotificationsRule](#NotificationsRule), unless you want your JSON data object to include data about the thresholds you set. For more information, see [set budget threshold rules and actions](https://cloud.google.com/billing/docs/how-to/budgets#budget-actions).",
"id": "GoogleCloudBillingBudgetsV1beta1ThresholdRule",
"properties": {
"spendBasis": {
@@ -492,7 +492,7 @@
"enumDescriptions": [
"Unspecified threshold basis.",
"Use current spend as the basis for comparison against the threshold.",
"Use forecasted spend for the period as the basis for comparison against the threshold. Cannot be set in combination with Filter.custom_period."
"Use forecasted spend for the period as the basis for comparison against the threshold. FORECASTED_SPEND can only be set when the budget's time period is a Filter.calendar_period. It cannot be set in combination with Filter.custom_period."
],
"type": "string"
},
@@ -527,7 +527,7 @@
"type": "object"
},
"GoogleTypeDate": {
"description": "Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.",
"description": "Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day, with a zero year (e.g., an anniversary) * A year on its own, with a zero month and a zero day * A year and month, with a zero day (e.g., a credit card expiration date) Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp",
"id": "GoogleTypeDate",
"properties": {
"day": {

52
etc/api/binaryauthorization/v1/binaryauthorization-api.json
View File

@@ -3,7 +3,7 @@
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "View and manage your data across Google Cloud Platform services"
"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
}
}
}
@@ -12,7 +12,7 @@
"baseUrl": "https://binaryauthorization.googleapis.com/",
"batchPath": "batch",
"canonicalName": "Binary Authorization",
"description": "The management interface for Binary Authorization, a system providing policy control for images deployed to Kubernetes Engine clusters. ",
"description": "The management interface for Binary Authorization, a service that provides policy-based deployment validation and control for images deployed to Google Kubernetes Engine (GKE), Anthos Service Mesh, Anthos Clusters, and Cloud Run. ",
"discoveryVersion": "v1",
"documentationLink": "https://cloud.google.com/binary-authorization/",
"fullyEncodeReservedExpansion": true,
@@ -257,7 +257,7 @@
],
"parameters": {
"options.requestedPolicyVersion": {
"description": "Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
"format": "int32",
"location": "query",
"type": "integer"
@@ -440,7 +440,7 @@
],
"parameters": {
"options.requestedPolicyVersion": {
"description": "Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
"format": "int32",
"location": "query",
"type": "integer"
@@ -551,7 +551,7 @@
}
}
},
"revision": "20210318",
"revision": "20220225",
"rootUrl": "https://binaryauthorization.googleapis.com/",
"schemas": {
"AdmissionRule": {
@@ -583,7 +583,7 @@
"enumDescriptions": [
"Do not use.",
"This rule allows all all pod creations.",
"This rule allows a pod creation if all the attestors listed in 'require_attestations_by' have valid attestations for all of the images in the pod spec.",
"This rule allows a pod creation if all the attestors listed in `require_attestations_by` have valid attestations for all of the images in the pod spec.",
"This rule denies all pod creations."
],
"type": "string"
@@ -603,7 +603,7 @@
"id": "AdmissionWhitelistPattern",
"properties": {
"namePattern": {
"description": "An image name pattern to allowlist, in the form `registry/path/to/image`. This supports a trailing `*` as a wildcard, but this is allowed only in text after the `registry/` part.",
"description": "An image name pattern to allowlist, in the form `registry/path/to/image`. This supports a trailing `*` wildcard, but this is allowed only in text after the `registry/` part. This also supports a trailing `**` wildcard which matches subdirectories of a given entry.",
"type": "string"
}
},
@@ -643,6 +643,10 @@
"description": "Optional. A descriptive comment. This field may be updated. The field may be displayed in chooser dialogs.",
"type": "string"
},
"etag": {
"description": "Optional. Used to prevent updating the attestor when another request has updated it since it was retrieved.",
"type": "string"
},
"name": {
"description": "Required. The resource name, in the format: `projects/*/attestors/*`. This field may not be updated.",
"type": "string"
@@ -684,22 +688,22 @@
"type": "object"
},
"Binding": {
"description": "Associates `members` with a `role`.",
"description": "Associates `members`, or principals, with a `role`.",
"id": "Binding",
"properties": {
"condition": {
"$ref": "Expr",
"description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)."
"description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)."
},
"members": {
"description": "Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ",
"description": "Specifies the principals requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ",
"items": {
"type": "string"
},
"type": "array"
},
"role": {
"description": "Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.",
"description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.",
"type": "string"
}
},
@@ -735,11 +739,11 @@
"type": "object"
},
"IamPolicy": {
"description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).",
"description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).",
"id": "IamPolicy",
"properties": {
"bindings": {
"description": "Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.",
"description": "Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.",
"items": {
"$ref": "Binding"
},
@@ -799,9 +803,13 @@
"enum": [
"SIGNATURE_ALGORITHM_UNSPECIFIED",
"RSA_PSS_2048_SHA256",
"RSA_SIGN_PSS_2048_SHA256",
"RSA_PSS_3072_SHA256",
"RSA_SIGN_PSS_3072_SHA256",
"RSA_PSS_4096_SHA256",
"RSA_SIGN_PSS_4096_SHA256",
"RSA_PSS_4096_SHA512",
"RSA_SIGN_PSS_4096_SHA512",
"RSA_SIGN_PKCS1_2048_SHA256",
"RSA_SIGN_PKCS1_3072_SHA256",
"RSA_SIGN_PKCS1_4096_SHA256",
@@ -816,8 +824,12 @@
"enumDescriptions": [
"Not specified.",
"RSASSA-PSS 2048 bit key with a SHA256 digest.",
"RSASSA-PSS 2048 bit key with a SHA256 digest.",
"RSASSA-PSS 3072 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 SHA256 digest.",
"RSASSA-PSS 4096 bit key with a SHA512 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.",
@@ -861,6 +873,10 @@
"description": "Optional. A descriptive comment.",
"type": "string"
},
"etag": {
"description": "Optional. Used to prevent updating the policy when another request has updated it since it was retrieved.",
"type": "string"
},
"globalPolicyEvaluationMode": {
"description": "Optional. Controls the evaluation of a Google-maintained global admission policy for common system-level images. Images not covered by the global policy will be subject to the project admission policy. This setting has no effect when specified inside a global admission policy.",
"enum": [
@@ -870,8 +886,8 @@
],
"enumDescriptions": [
"Not specified: DISABLE is assumed.",
"Enables global policy evaluation.",
"Disables global policy evaluation."
"Enables system policy evaluation.",
"Disables system policy evaluation."
],
"type": "string"
},
@@ -879,21 +895,21 @@
"additionalProperties": {
"$ref": "AdmissionRule"
},
"description": "Optional. Per-istio-service-identity admission rules. Istio service identity spec format: spiffe:///ns//sa/ or /ns//sa/ e.g. spiffe://example.com/ns/test-ns/sa/default",
"description": "Optional. Per-istio-service-identity admission rules. Istio service identity spec format: `spiffe:///ns//sa/` or `/ns//sa/` e.g. `spiffe://example.com/ns/test-ns/sa/default`",
"type": "object"
},
"kubernetesNamespaceAdmissionRules": {
"additionalProperties": {
"$ref": "AdmissionRule"
},
"description": "Optional. Per-kubernetes-namespace admission rules. K8s namespace spec format: [a-z.-]+, e.g. 'some-namespace'",
"description": "Optional. Per-kubernetes-namespace admission rules. K8s namespace spec format: `[a-z.-]+`, e.g. `some-namespace`",
"type": "object"
},
"kubernetesServiceAccountAdmissionRules": {
"additionalProperties": {
"$ref": "AdmissionRule"
},
"description": "Optional. Per-kubernetes-service-account admission rules. Service account spec format: `namespace:serviceaccount`. e.g. 'test-ns:default'",
"description": "Optional. Per-kubernetes-service-account admission rules. Service account spec format: `namespace:serviceaccount`. e.g. `test-ns:default`",
"type": "object"
},
"name": {

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

@@ -3,7 +3,7 @@
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "View and manage your data across Google Cloud Platform services"
"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
}
}
}
@@ -12,7 +12,7 @@
"baseUrl": "https://binaryauthorization.googleapis.com/",
"batchPath": "batch",
"canonicalName": "Binary Authorization",
"description": "The management interface for Binary Authorization, a system providing policy control for images deployed to Kubernetes Engine clusters. ",
"description": "The management interface for Binary Authorization, a service that provides policy-based deployment validation and control for images deployed to Google Kubernetes Engine (GKE), Anthos Service Mesh, Anthos Clusters, and Cloud Run. ",
"discoveryVersion": "v1",
"documentationLink": "https://cloud.google.com/binary-authorization/",
"fullyEncodeReservedExpansion": true,
@@ -257,7 +257,7 @@
],
"parameters": {
"options.requestedPolicyVersion": {
"description": "Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
"format": "int32",
"location": "query",
"type": "integer"
@@ -440,7 +440,7 @@
],
"parameters": {
"options.requestedPolicyVersion": {
"description": "Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
"format": "int32",
"location": "query",
"type": "integer"
@@ -551,7 +551,7 @@
}
}
},
"revision": "20210318",
"revision": "20220225",
"rootUrl": "https://binaryauthorization.googleapis.com/",
"schemas": {
"AdmissionRule": {
@@ -583,7 +583,7 @@
"enumDescriptions": [
"Do not use.",
"This rule allows all all pod creations.",
"This rule allows a pod creation if all the attestors listed in 'require_attestations_by' have valid attestations for all of the images in the pod spec.",
"This rule allows a pod creation if all the attestors listed in `require_attestations_by` have valid attestations for all of the images in the pod spec.",
"This rule denies all pod creations."
],
"type": "string"
@@ -603,7 +603,7 @@
"id": "AdmissionWhitelistPattern",
"properties": {
"namePattern": {
"description": "An image name pattern to allowlist, in the form `registry/path/to/image`. This supports a trailing `*` as a wildcard, but this is allowed only in text after the `registry/` part. Also wildcards do not match `/`, i.e., gcr.io/nginx* matches gcr.io/nginx@latest, but it does not match gcr.io/nginx/image.",
"description": "An image name pattern to allowlist, in the form `registry/path/to/image`. This supports a trailing `*` as a wildcard, but this is allowed only in text after the `registry/` part. `*` wildcard does not match `/`, i.e., `gcr.io/nginx*` matches `gcr.io/nginx@latest`, but it does not match `gcr.io/nginx/image`. This also supports a trailing `**` wildcard which matches subdirectories, i.e., `gcr.io/nginx**` matches `gcr.io/nginx/image`.",
"type": "string"
}
},
@@ -643,6 +643,10 @@
"description": "Optional. A descriptive comment. This field may be updated. The field may be displayed in chooser dialogs.",
"type": "string"
},
"etag": {
"description": "Optional. Used to prevent updating the attestor when another request has updated it since it was retrieved.",
"type": "string"
},
"name": {
"description": "Required. The resource name, in the format: `projects/*/attestors/*`. This field may not be updated.",
"type": "string"
@@ -684,22 +688,22 @@
"type": "object"
},
"Binding": {
"description": "Associates `members` with a `role`.",
"description": "Associates `members`, or principals, with a `role`.",
"id": "Binding",
"properties": {
"condition": {
"$ref": "Expr",
"description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)."
"description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)."
},
"members": {
"description": "Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ",
"description": "Specifies the principals requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ",
"items": {
"type": "string"
},
"type": "array"
},
"role": {
"description": "Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.",
"description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.",
"type": "string"
}
},
@@ -735,11 +739,11 @@
"type": "object"
},
"IamPolicy": {
"description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).",
"description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).",
"id": "IamPolicy",
"properties": {
"bindings": {
"description": "Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.",
"description": "Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.",
"items": {
"$ref": "Binding"
},
@@ -799,9 +803,13 @@
"enum": [
"SIGNATURE_ALGORITHM_UNSPECIFIED",
"RSA_PSS_2048_SHA256",
"RSA_SIGN_PSS_2048_SHA256",
"RSA_PSS_3072_SHA256",
"RSA_SIGN_PSS_3072_SHA256",
"RSA_PSS_4096_SHA256",
"RSA_SIGN_PSS_4096_SHA256",
"RSA_PSS_4096_SHA512",
"RSA_SIGN_PSS_4096_SHA512",
"RSA_SIGN_PKCS1_2048_SHA256",
"RSA_SIGN_PKCS1_3072_SHA256",
"RSA_SIGN_PKCS1_4096_SHA256",
@@ -816,8 +824,12 @@
"enumDescriptions": [
"Not specified.",
"RSASSA-PSS 2048 bit key with a SHA256 digest.",
"RSASSA-PSS 2048 bit key with a SHA256 digest.",
"RSASSA-PSS 3072 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 SHA256 digest.",
"RSASSA-PSS 4096 bit key with a SHA512 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.",
@@ -836,7 +848,7 @@
"type": "object"
},
"Policy": {
"description": "A policy for container image binary authorization.",
"description": "A policy for Binary Authorization.",
"id": "Policy",
"properties": {
"admissionWhitelistPatterns": {
@@ -861,6 +873,10 @@
"description": "Optional. A descriptive comment.",
"type": "string"
},
"etag": {
"description": "Optional. Used to prevent updating the policy when another request has updated it since it was retrieved.",
"type": "string"
},
"globalPolicyEvaluationMode": {
"description": "Optional. Controls the evaluation of a Google-maintained global admission policy for common system-level images. Images not covered by the global policy will be subject to the project admission policy. This setting has no effect when specified inside a global admission policy.",
"enum": [
@@ -870,8 +886,8 @@
],
"enumDescriptions": [
"Not specified: DISABLE is assumed.",
"Enables global policy evaluation.",
"Disables global policy evaluation."
"Enables system policy evaluation.",
"Disables system policy evaluation."
],
"type": "string"
},
@@ -879,21 +895,21 @@
"additionalProperties": {
"$ref": "AdmissionRule"
},
"description": "Optional. Per-istio-service-identity admission rules. Istio service identity spec format: spiffe:///ns//sa/ or /ns//sa/ e.g. spiffe://example.com/ns/test-ns/sa/default",
"description": "Optional. Per-istio-service-identity admission rules. Istio service identity spec format: `spiffe:///ns//sa/` or `/ns//sa/` e.g. `spiffe://example.com/ns/test-ns/sa/default`",
"type": "object"
},
"kubernetesNamespaceAdmissionRules": {
"additionalProperties": {
"$ref": "AdmissionRule"
},
"description": "Optional. Per-kubernetes-namespace admission rules. K8s namespace spec format: [a-z.-]+, e.g. 'some-namespace'",
"description": "Optional. Per-kubernetes-namespace admission rules. K8s namespace spec format: `[a-z.-]+`, e.g. `some-namespace`",
"type": "object"
},
"kubernetesServiceAccountAdmissionRules": {
"additionalProperties": {
"$ref": "AdmissionRule"
},
"description": "Optional. Per-kubernetes-service-account admission rules. Service account spec format: `namespace:serviceaccount`. e.g. 'test-ns:default'",
"description": "Optional. Per-kubernetes-service-account admission rules. Service account spec format: `namespace:serviceaccount`. e.g. `test-ns:default`",
"type": "object"
},
"name": {

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

@@ -401,7 +401,7 @@
}
}
},
"revision": "20210331",
"revision": "20220305",
"rootUrl": "https://blogger.googleapis.com/",
"schemas": {
"Blog": {
@@ -799,9 +799,11 @@
"description": "The status of the page for admin resources (either LIVE or DRAFT).",
"enum": [
"LIVE",
"DRAFT"
"DRAFT",
"SOFT_TRASHED"
],
"enumDescriptions": [
"",
"",
""
],
@@ -1000,9 +1002,11 @@
"enum": [
"LIVE",
"DRAFT",
"SCHEDULED"
"SCHEDULED",
"SOFT_TRASHED"
],
"enumDescriptions": [
"",
"",
"",
""

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

@@ -826,9 +826,11 @@
"status": {
"enum": [
"LIVE",
"DRAFT"
"DRAFT",
"SOFT_TRASHED"
],
"enumDescriptions": [
"",
"",
""
],
@@ -1105,9 +1107,11 @@
"enum": [
"LIVE",
"DRAFT",
"SCHEDULED"
"SCHEDULED",
"SOFT_TRASHED"
],
"enumDescriptions": [
"",
"",
"",
""
@@ -1390,9 +1394,11 @@
"enum": [
"LIVE",
"DRAFT",
"SCHEDULED"
"SCHEDULED",
"SOFT_TRASHED"
],
"enumDescriptions": [
"",
"",
"",
""
@@ -1678,7 +1684,7 @@
}
}
},
"revision": "20210331",
"revision": "20220305",
"rootUrl": "https://blogger.googleapis.com/",
"schemas": {
"Blog": {
@@ -2076,9 +2082,11 @@
"description": "The status of the page for admin resources (either LIVE or DRAFT).",
"enum": [
"LIVE",
"DRAFT"
"DRAFT",
"SOFT_TRASHED"
],
"enumDescriptions": [
"",
"",
""
],
@@ -2319,9 +2327,11 @@
"enum": [
"LIVE",
"DRAFT",
"SCHEDULED"
"SCHEDULED",
"SOFT_TRASHED"
],
"enumDescriptions": [
"",
"",
"",
""

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

@@ -2671,7 +2671,7 @@
}
}
},
"revision": "20210326",
"revision": "20220301",
"rootUrl": "https://books.googleapis.com/",
"schemas": {
"Annotation": {

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

@@ -814,7 +814,7 @@
"enumDescriptions": [
"Notifications are sent to all guests.",
"Notifications are sent to non-Google Calendar guests only.",
"No notifications are sent. This value should only be used for migration use cases (note that in most migration cases the import method should be used)."
"No notifications are sent. For calendar migration tasks, consider using the Events.import method instead."
],
"location": "query",
"type": "string"
@@ -960,7 +960,7 @@
"enumDescriptions": [
"Notifications are sent to all guests.",
"Notifications are sent to non-Google Calendar guests only.",
"No notifications are sent. This value should only be used for migration use cases (note that in most migration cases the import method should be used)."
"No notifications are sent. Warning: Using the value none can have significant adverse effects, including events not syncing to external calendars or events being lost altogether for some users. For calendar migration tasks, consider using the events.import method instead."
],
"location": "query",
"type": "string"
@@ -1241,7 +1241,7 @@
"enumDescriptions": [
"Notifications are sent to all guests.",
"Notifications are sent to non-Google Calendar guests only.",
"No notifications are sent. This value should only be used for migration use cases (note that in most migration cases the import method should be used)."
"No notifications are sent. For calendar migration tasks, consider using the Events.import method instead."
],
"location": "query",
"type": "string"
@@ -1312,7 +1312,7 @@
"enumDescriptions": [
"Notifications are sent to all guests.",
"Notifications are sent to non-Google Calendar guests only.",
"No notifications are sent. This value should only be used for migration use cases (note that in most migration cases the import method should be used)."
"No notifications are sent. For calendar migration tasks, consider using the Events.import method instead."
],
"location": "query",
"type": "string"
@@ -1365,7 +1365,7 @@
"enumDescriptions": [
"Notifications are sent to all guests.",
"Notifications are sent to non-Google Calendar guests only.",
"No notifications are sent. This value should only be used for migration use cases (note that in most migration cases the import method should be used)."
"No notifications are sent. For calendar migration tasks, consider using the Events.import method instead."
],
"location": "query",
"type": "string"
@@ -1442,7 +1442,7 @@
"enumDescriptions": [
"Notifications are sent to all guests.",
"Notifications are sent to non-Google Calendar guests only.",
"No notifications are sent. This value should only be used for migration use cases (note that in most migration cases the import method should be used)."
"No notifications are sent. For calendar migration tasks, consider using the Events.import method instead."
],
"location": "query",
"type": "string"
@@ -1723,7 +1723,7 @@
}
}
},
"revision": "20210327",
"revision": "20220217",
"rootUrl": "https://www.googleapis.com/",
"schemas": {
"Acl": {
@@ -2074,9 +2074,9 @@
"calendar": {
"additionalProperties": {
"$ref": "ColorDefinition",
"description": "A calendar color defintion."
"description": "A calendar color definition."
},
"description": "A global palette of calendar colors, mapping from the color ID to its definition. A calendarListEntry resource refers to one of these color IDs in its color field. Read-only.",
"description": "A global palette of calendar colors, mapping from the color ID to its definition. A calendarListEntry resource refers to one of these color IDs in its colorId field. Read-only.",
"type": "object"
},
"event": {
@@ -2084,7 +2084,7 @@
"$ref": "ColorDefinition",
"description": "An event color definition."
},
"description": "A global palette of event colors, mapping from the color ID to its definition. An event resource may refer to one of these color IDs in its color field. Read-only.",
"description": "A global palette of event colors, mapping from the color ID to its definition. An event resource may refer to one of these color IDs in its colorId field. Read-only.",
"type": "object"
},
"kind": {
@@ -2104,12 +2104,12 @@
"id": "ConferenceData",
"properties": {
"conferenceId": {
"description": "The ID of the conference.\nCan be used by developers to keep track of conferences, should not be displayed to users.\nValues for solution types: \n- \"eventHangout\": unset.\n- \"eventNamedHangout\": the name of the Hangout.\n- \"hangoutsMeet\": the 10-letter meeting code, for example \"aaa-bbbb-ccc\".\n- \"addOn\": defined by 3P conference provider. Optional.",
"description": "The ID of the conference.\nCan be used by developers to keep track of conferences, should not be displayed to users.\nThe ID value is formed differently for each conference solution type: \n- eventHangout: ID is not set. (This conference type is deprecated.)\n- eventNamedHangout: ID is the name of the Hangout. (This conference type is deprecated.)\n- hangoutsMeet: ID is the 10-letter meeting code, for example aaa-bbbb-ccc.\n- addOn: ID is defined by the third-party provider. Optional.",
"type": "string"
},
"conferenceSolution": {
"$ref": "ConferenceSolution",
"description": "The conference solution, such as Hangouts or Google Meet.\nUnset for a conference with a failed create request.\nEither conferenceSolution and at least one entryPoint, or createRequest is required."
"description": "The conference solution, such as Google Meet.\nUnset for a conference with a failed create request.\nEither conferenceSolution and at least one entryPoint, or createRequest is required."
},
"createRequest": {
"$ref": "CreateConferenceRequest",
@@ -2131,7 +2131,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.\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.",
"description": "The signature of the conference data.\nGenerated on server side.\nUnset for a conference with a failed create request.\nOptional for a conference with a pending create request.",
"type": "string"
}
},
@@ -2204,7 +2204,7 @@
"id": "ConferenceSolutionKey",
"properties": {
"type": {
"description": "The conference solution type.\nIf a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.\nThe possible values are: \n- \"eventHangout\" for Hangouts for consumers (http://hangouts.google.com)\n- \"eventNamedHangout\" for classic Hangouts for Google Workspace users (http://hangouts.google.com)\n- \"hangoutsMeet\" for Google Meet (http://meet.google.com)\n- \"addOn\" for 3P conference providers",
"description": "The conference solution type.\nIf a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.\nThe possible values are: \n- \"eventHangout\" for Hangouts for consumers (deprecated; existing events may show this conference solution type but new conferences cannot be created)\n- \"eventNamedHangout\" for classic Hangouts for Google Workspace users (deprecated; existing events may show this conference solution type but new conferences cannot be created)\n- \"hangoutsMeet\" for Google Meet (http://meet.google.com)\n- \"addOn\" for 3P conference providers",
"type": "string"
}
},
@@ -2296,7 +2296,7 @@
"properties": {
"anyoneCanAddSelf": {
"default": "false",
"description": "Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False.",
"description": "Whether anyone can invite themselves to the event (deprecated). Optional. The default is False.",
"type": "boolean"
},
"attachments": {
@@ -2343,7 +2343,7 @@
"type": "string"
},
"id": {
"description": "The creator's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API",
"description": "The creator's Profile ID, if available.",
"type": "string"
},
"self": {
@@ -2380,7 +2380,7 @@
},
"eventType": {
"default": "default",
"description": "Specific type of the event. Read-only. Possible values are: \n- \"default\" - A regular event or not further specified. \n- \"outOfOffice\" - An out-of-office event.",
"description": "Specific type of the event. Read-only. Possible values are: \n- \"default\" - A regular event or not further specified. \n- \"outOfOffice\" - An out-of-office event. \n- \"focusTime\" - A focus-time event.",
"type": "string"
},
"extendedProperties": {
@@ -2465,7 +2465,7 @@
"type": "boolean"
},
"hangoutLink": {
"description": "An absolute link to the Google+ hangout associated with this event. Read-only.",
"description": "An absolute link to the Google Hangout associated with this event. Read-only.",
"type": "string"
},
"htmlLink": {
@@ -2511,7 +2511,7 @@
"type": "string"
},
"id": {
"description": "The organizer's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API",
"description": "The organizer's Profile ID, if available.",
"type": "string"
},
"self": {
@@ -2663,7 +2663,7 @@
"type": "string"
},
"id": {
"description": "The attendee's Profile ID, if available. It corresponds to the id field in the People collection of the Google+ API",
"description": "The attendee's Profile ID, if available.",
"type": "string"
},
"optional": {

1698
etc/api/certificatemanager/v1/certificatemanager-api.json Normal file
View File

File diff suppressed because it is too large Load Diff

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

File diff suppressed because it is too large Load Diff

1301
etc/api/chromemanagement/v1/chromemanagement-api.json
View File

File diff suppressed because it is too large Load Diff

183
etc/api/chromepolicy/v1/chromepolicy-api.json
View File

@@ -146,7 +146,7 @@
"orgunits": {
"methods": {
"batchInherit": {
"description": "Modify multiple policy values that are applied to a specific org unit so that they now inherit the value from a parent (if applicable). All targets must have the same target format. That is to say that they must point to the same target resource and must have the same keys specified in `additionalTargetKeyNames`. On failure the request will return the error details as part of the google.rpc.Status.",
"description": "Modify multiple policy values that are applied to a specific org unit so that they now inherit the value from a parent (if applicable). All targets must have the same target format. That is to say that they must point to the same target resource and must have the same keys specified in `additionalTargetKeyNames`, though the values for those keys may be different. On failure the request will return the error details as part of the google.rpc.Status.",
"flatPath": "v1/customers/{customersId}/policies/orgunits:batchInherit",
"httpMethod": "POST",
"id": "chromepolicy.customers.policies.orgunits.batchInherit",
@@ -174,7 +174,7 @@
]
},
"batchModify": {
"description": "Modify multiple policy values that are applied to a specific org unit. All targets must have the same target format. That is to say that they must point to the same target resource and must have the same keys specified in `additionalTargetKeyNames`. On failure the request will return the error details as part of the google.rpc.Status.",
"description": "Modify multiple policy values that are applied to a specific org unit. All targets must have the same target format. That is to say that they must point to the same target resource and must have the same keys specified in `additionalTargetKeyNames`, though the values for those keys may be different. On failure the request will return the error details as part of the google.rpc.Status.",
"flatPath": "v1/customers/{customersId}/policies/orgunits:batchModify",
"httpMethod": "POST",
"id": "chromepolicy.customers.policies.orgunits.batchModify",
@@ -278,11 +278,87 @@
}
}
}
},
"media": {
"methods": {
"upload": {
"description": "Creates an enterprise file from the content provided by user. Returns a public download url for end user.",
"flatPath": "v1/customers/{customersId}/policies/files:uploadPolicyFile",
"httpMethod": "POST",
"id": "chromepolicy.media.upload",
"mediaUpload": {
"accept": [
"*/*"
],
"protocols": {
"simple": {
"multipart": true,
"path": "/upload/v1/{+customer}/policies/files:uploadPolicyFile"
}
}
},
"parameterOrder": [
"customer"
],
"parameters": {
"customer": {
"description": "Required. The customer for which the file upload will apply.",
"location": "path",
"pattern": "^customers/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+customer}/policies/files:uploadPolicyFile",
"request": {
"$ref": "GoogleChromePolicyV1UploadPolicyFileRequest"
},
"response": {
"$ref": "GoogleChromePolicyV1UploadPolicyFileResponse"
},
"scopes": [
"https://www.googleapis.com/auth/chrome.management.policy"
],
"supportsMediaUpload": true
}
}
}
},
"revision": "20210329",
"revision": "20220305",
"rootUrl": "https://chromepolicy.googleapis.com/",
"schemas": {
"ChromeCrosDpanelAutosettingsProtoPolicyApiLifecycle": {
"id": "ChromeCrosDpanelAutosettingsProtoPolicyApiLifecycle",
"properties": {
"description": {
"description": "Description about current life cycle.",
"type": "string"
},
"endSupport": {
"$ref": "GoogleTypeDate",
"description": "End supporting date for current policy."
},
"policyApiLifecycleStage": {
"description": "Indicate current life cycle stage of the policy API.",
"enum": [
"API_UNSPECIFIED",
"API_PREVIEW",
"API_DEVELOPMENT",
"API_CURRENT",
"API_DEPRECATED"
],
"enumDescriptions": [
"unspecified.",
"Policy is not working yet, but giving developers heads up on format. This stage can transfer to API_DEVELOPEMNT or API_CURRENT.",
"Policy can change format in backward incompatible way (breaking change). This stage can transfer to API_CURRENT or API_DEPRECATED. This could be used for policies launched only to TTs or launched to selected customers for emergency usage.",
"Policy in official format. Policy can change format in backward compatible way (non-breaking change). Example: this policy can introduce a new field, which is considered non-breaking change, when field masks are properly utilized. This stage can transfer to API_DEPRECATED.",
"Please stop using this policy. This policy is deprecated and may/will be removed in the future. Most likely a new policy was introduced to replace this one."
],
"type": "string"
}
},
"type": "object"
},
"GoogleChromePolicyV1AdditionalTargetKeyName": {
"description": "Additional key names that will be used to identify the target of the policy value.",
"id": "GoogleChromePolicyV1AdditionalTargetKeyName",
@@ -380,7 +456,7 @@
"type": "object"
},
"GoogleChromePolicyV1PolicySchema": {
"description": "Resource representing a policy schema. Next ID: 10",
"description": "Resource representing a policy schema. Next ID: 12",
"id": "GoogleChromePolicyV1PolicySchema",
"properties": {
"accessRestrictions": {
@@ -423,13 +499,18 @@
"readOnly": true,
"type": "array"
},
"policyApiLifeycle": {
"$ref": "ChromeCrosDpanelAutosettingsProtoPolicyApiLifecycle",
"description": "Output only. Current life cycle information.",
"readOnly": true
},
"policyDescription": {
"description": "Output only. Description about the policy schema for user consumption.",
"readOnly": true,
"type": "string"
},
"schemaName": {
"description": "Output only. The full qualified name of the policy schema. This value is used to fill the field `policy_schema` in PolicyValue when calling BatchInheritOrgUnitPolicies or BatchModifyOrgUnitPolicies.",
"description": "Output only. The fully qualified name of the policy schema. This value is used to fill the field `policy_schema` in PolicyValue when calling BatchInheritOrgUnitPolicies or BatchModifyOrgUnitPolicies",
"readOnly": true,
"type": "string"
},
@@ -437,6 +518,39 @@
"description": "Output only. URI to related support article for this schema.",
"readOnly": true,
"type": "string"
},
"validTargetResources": {
"description": "Output only. Information about applicable target resources for the policy.",
"items": {
"enum": [
"TARGET_RESOURCE_UNSPECIFIED",
"ORG_UNIT",
"GROUP"
],
"enumDescriptions": [
"Unspecified target resource.",
"Organizational Unit target resource.",
"Group target resource."
],
"type": "string"
},
"readOnly": true,
"type": "array"
}
},
"type": "object"
},
"GoogleChromePolicyV1PolicySchemaFieldDependencies": {
"description": "The field and the value it must have for another field to be allowed to be set.",
"id": "GoogleChromePolicyV1PolicySchemaFieldDependencies",
"properties": {
"sourceField": {
"description": "The source field which this field depends on.",
"type": "string"
},
"sourceFieldValue": {
"description": "The value which the source field must have for this field to be allowed to be set.",
"type": "string"
}
},
"type": "object"
@@ -455,13 +569,21 @@
"readOnly": true,
"type": "string"
},
"fieldDependencies": {
"description": "Output only. Provides a list of fields and the values they must have for this field to be allowed to be set.",
"items": {
"$ref": "GoogleChromePolicyV1PolicySchemaFieldDependencies"
},
"readOnly": true,
"type": "array"
},
"inputConstraint": {
"description": "Output only. Any input constraints associated on the values for the field.",
"readOnly": true,
"type": "string"
},
"knownValueDescriptions": {
"description": "Output only. If the field has a set of know values, this field will provide a description for these values.",
"description": "Output only. If the field has a set of known values, this field will provide a description for these values.",
"items": {
"$ref": "GoogleChromePolicyV1PolicySchemaFieldKnownValueDescription"
},
@@ -606,6 +728,11 @@
"description": "The resolved value of a policy for a given target.",
"id": "GoogleChromePolicyV1ResolvedPolicy",
"properties": {
"addedSourceKey": {
"$ref": "GoogleChromePolicyV1PolicyTargetKey",
"description": "Output only. The added source key establishes at which level an entity was explicitly added for management. This is useful for certain type of policies that are only applied if they are explicitly added for management. For example: apps and networks. An entity can only be deleted from management in an Organizational Unit that it was explicitly added to. If this is not present it means that the policy is managed without the need to explicitly add an entity, for example: standard user or device policies.",
"readOnly": true
},
"sourceKey": {
"$ref": "GoogleChromePolicyV1PolicyTargetKey",
"description": "Output only. The source resource from which this policy value is obtained. May be the same as `targetKey` if the policy is directly modified on the target, otherwise it would be another resource from which the policy gets its value (if applicable). If not present, the source is the default value for the customer.",
@@ -624,12 +751,56 @@
},
"type": "object"
},
"GoogleChromePolicyV1UploadPolicyFileRequest": {
"description": "Request message for uploading a file for a policy. Next ID: 5",
"id": "GoogleChromePolicyV1UploadPolicyFileRequest",
"properties": {
"policyField": {
"description": "Required. The fully qualified policy schema and field name this file is uploaded for. This information will be used to validate the content type of the file.",
"type": "string"
}
},
"type": "object"
},
"GoogleChromePolicyV1UploadPolicyFileResponse": {
"description": "Response message for downloading an uploaded file. Next ID: 2",
"id": "GoogleChromePolicyV1UploadPolicyFileResponse",
"properties": {
"downloadUri": {
"description": "The uri for end user to download the file.",
"type": "string"
}
},
"type": "object"
},
"GoogleProtobufEmpty": {
"description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.",
"id": "GoogleProtobufEmpty",
"properties": {},
"type": "object"
},
"GoogleTypeDate": {
"description": "Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp",
"id": "GoogleTypeDate",
"properties": {
"day": {
"description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.",
"format": "int32",
"type": "integer"
},
"month": {
"description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.",
"format": "int32",
"type": "integer"
},
"year": {
"description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"Proto2DescriptorProto": {
"description": "Describes a message type.",
"id": "Proto2DescriptorProto",

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

@@ -116,7 +116,7 @@
}
}
},
"revision": "20210330",
"revision": "20220302",
"rootUrl": "https://chromeuxreport.googleapis.com/",
"schemas": {
"Bin": {
@@ -228,7 +228,7 @@
"type": "string"
},
"metrics": {
"description": "The metrics that should be included in the response. If none are specified then any metrics found will be returned. Allowed values: [\"first_contentful_paint\", \"first_input_delay\", \"largest_contentful_paint\", \"cumulative_layout_shift\"]",
"description": "The metrics that should be included in the response. If none are specified then any metrics found will be returned. Allowed values: [\"first_contentful_paint\", \"first_input_delay\", \"largest_contentful_paint\", \"cumulative_layout_shift\", \"experimental_uncapped_cumulative_layout_shift\"]",
"items": {
"type": "string"
},

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

@@ -234,7 +234,8 @@
"highestCourtJudge",
"judge",
"schoolBoard",
"specialPurposeOfficer"
"specialPurposeOfficer",
"otherRole"
],
"enumDescriptions": [
"",
@@ -247,6 +248,7 @@
"",
"",
"",
"",
""
],
"location": "query",
@@ -320,7 +322,8 @@
"highestCourtJudge",
"judge",
"schoolBoard",
"specialPurposeOfficer"
"specialPurposeOfficer",
"otherRole"
],
"enumDescriptions": [
"",
@@ -333,6 +336,7 @@
"",
"",
"",
"",
""
],
"location": "query",
@@ -348,7 +352,7 @@
}
}
},
"revision": "20210108",
"revision": "20211211",
"rootUrl": "https://civicinfo.googleapis.com/",
"schemas": {
"AdministrationRegion": {
@@ -647,7 +651,8 @@
"highestCourtJudge",
"judge",
"schoolBoard",
"specialPurposeOfficer"
"specialPurposeOfficer",
"otherRole"
],
"enumDescriptions": [
"",
@@ -660,6 +665,7 @@
"",
"",
"",
"",
""
],
"type": "string"
@@ -845,6 +851,793 @@
},
"type": "object"
},
"FeatureIdProto": {
"description": "A globally unique identifier associated with each feature. We use 128-bit identifiers so that we have lots of bits available to distinguish between features. The feature id currently consists of a 64-bit \"cell id\" that **sometimes** corresponds to the approximate centroid of the feature, plus a 64-bit fingerprint of other identifying information. See more on each respective field in its comments. Feature ids are first assigned when the data is created in MapFacts. After initial creation of the feature, they are immutable. This means that the only properties that you should rely on are that they are unique, and that cell_ids often - but not always - preserve spatial locality. The degree of locality varies as the feature undergoes geometry changes, and should not in general be considered a firm guarantee of the location of any particular feature. In fact, some locationless features have randomized cell IDs! Consumers of FeatureProtos from Mapfacts are guaranteed that fprints in the id field of features will be globally unique. Using the fprint allows consumers who don't need the spatial benefit of cell ids to uniquely identify features in a 64-bit address space. This property is not guaranteed for other sources of FeatureProtos.",
"id": "FeatureIdProto",
"properties": {
"cellId": {
"description": "The S2CellId corresponding to the approximate location of this feature as of when it was first created. This can be of variable accuracy, ranging from the exact centroid of the feature at creation, a very large S2 Cell, or even being completely randomized for locationless features. Cell ids have the nice property that they follow a space-filling curve over the surface of the earth. (See s2cellid.h for details.) WARNING: Clients should only use cell IDs to perform spatial locality optimizations. There is no strict guarantee that the cell ID of a feature is related to the current geometry of the feature in any way.",
"format": "uint64",
"type": "string"
},
"fprint": {
"description": "A 64-bit fingerprint used to identify features. Most clients should rely on MapFacts or OneRing to choose fingerprints. If creating new fprints, the strategy should be chosen so that the chance of collision is remote or non-existent, and the distribution should be reasonably uniform. For example, if the source data assigns unique ids to features, then a fingerprint of the provider name, version, and source id is sufficient.",
"format": "uint64",
"type": "string"
},
"temporaryData": {
"$ref": "MessageSet",
"description": "A place for clients to attach arbitrary data to a feature ID. Never set in MapFacts."
}
},
"type": "object"
},
"GeocodingSummary": {
"description": "Detailed summary of the result from geocoding an address",
"id": "GeocodingSummary",
"properties": {
"addressUnderstood": {
"description": "Represents the best estimate of whether or not the input address was fully understood and the address is correctly componentized. Mirrors the same-name field in geostore.staging.AddressLinkupScoringProto.",
"type": "boolean"
},
"featureId": {
"$ref": "FeatureIdProto",
"description": "The ID of the FeatureProto returned by the geocoder"
},
"featureType": {
"description": "The feature type for the FeatureProto returned by the geocoder",
"enum": [
"typeAny",
"typeTransportation",
"typeRoute",
"typeDeprecatedHighwayDoNotUse",
"typeHighway",
"typeHighway1",
"typeHighway2",
"typeHighway3",
"typeHighway4",
"typeHighway5",
"typeHighway6",
"typeHighway7",
"typeHighway8",
"typeHighway9",
"typeBicycleRoute",
"typeTrail",
"typeSegment",
"typeRoad",
"typeRailway",
"typeStandardTrack",
"typeJrTrack",
"typeNarrowTrack",
"typeMonorailTrack",
"typeSubwayTrack",
"typeLightRailTrack",
"typeBroadTrack",
"typeHighSpeedRail",
"typeTrolleyTrack",
"typeFerry",
"typeFerryBoat",
"typeFerryTrain",
"typeVirtualSegment",
"typeIntersection",
"typeTransit",
"typeTransitStation",
"typeBusStation",
"typeTramwayStation",
"typeTrainStation",
"typeSubwayStation",
"typeFerryTerminal",
"typeAirport",
"typeAirportCivil",
"typeAirportMilitary",
"typeAirportMixed",
"typeHeliport",
"typeSeaplaneBase",
"typeAirstrip",
"typeCableCarStation",
"typeGondolaLiftStation",
"typeFunicularStation",
"typeSpecialStation",
"typeHorseCarriageStation",
"typeMonorailStation",
"typeSeaport",
"typeTransitStop",
"typeTransitTrip",
"typeTransitDeparture",
"typeTransitLeg",
"typeTransitLine",
"typeTransitAgency",
"typeTransitTransfer",
"typeSegmentPath",
"typeRoadSign",
"typeIntersectionGroup",
"typePathway",
"typeRestrictionGroup",
"typeTollCluster",
"typePolitical",
"typeCountry",
"typeAdministrativeArea",
"typeAdministrativeArea1",
"typeUsState",
"typeGbCountry",
"typeJpTodoufuken",
"typeAdministrativeArea2",
"typeGbFormerPostalCounty",
"typeGbTraditionalCounty",
"typeAdministrativeArea3",
"typeAdministrativeArea4",
"typeAdministrativeArea5",
"typeAdministrativeArea6",
"typeAdministrativeArea7",
"typeAdministrativeArea8",
"typeAdministrativeArea9",
"typeColloquialArea",
"typeReservation",
"typeLocality",
"typeGbPostTown",
"typeJpGun",
"typeJpShikuchouson",
"typeJpSubShikuchouson",
"typeColloquialCity",
"typeSublocality",
"typeUsBorough",
"typeGbDependentLocality",
"typeJpOoaza",
"typeJpKoaza",
"typeJpGaiku",
"typeGbDoubleDependentLocality",
"typeJpChiban",
"typeJpEdaban",
"typeSublocality1",
"typeSublocality2",
"typeSublocality3",
"typeSublocality4",
"typeSublocality5",
"typeNeighborhood",
"typeConstituency",
"typeDesignatedMarketArea",
"typeSchoolDistrict",
"typeLandParcel",
"typeDisputedArea",
"typePoliceJurisdiction",
"typeStatisticalArea",
"typeConstituencyFuture",
"typePark",
"typeGolfCourse",
"typeLocalPark",
"typeNationalPark",
"typeUsNationalPark",
"typeUsNationalMonument",
"typeNationalForest",
"typeProvincialPark",
"typeProvincialForest",
"typeCampgrounds",
"typeHikingArea",
"typeBusiness",
"typeGovernment",
"typeBorderCrossing",
"typeCityHall",
"typeCourthouse",
"typeEmbassy",
"typeLibrary",
"typeSchool",
"typeUniversity",
"typeEmergency",
"typeHospital",
"typePharmacy",
"typePolice",
"typeFire",
"typeDoctor",
"typeDentist",
"typeVeterinarian",
"typeTravelService",
"typeLodging",
"typeRestaurant",
"typeGasStation",
"typeParking",
"typePostOffice",
"typeRestArea",
"typeCashMachine",
"typeCarRental",
"typeCarRepair",
"typeShopping",
"typeGrocery",
"typeTouristDestination",
"typeEcoTouristDestination",
"typeBirdWatching",
"typeFishing",
"typeHunting",
"typeNatureReserve",
"typeTemple",
"typeChurch",
"typeGurudwara",
"typeHinduTemple",
"typeMosque",
"typeSynagogue",
"typeStadium",
"typeBar",
"typeMovieRental",
"typeCoffee",
"typeGolf",
"typeBank",
"typeDoodle",
"typeGrounds",
"typeAirportGrounds",
"typeBuildingGrounds",
"typeCemetery",
"typeHospitalGrounds",
"typeIndustrial",
"typeMilitary",
"typeShoppingCenter",
"typeSportsComplex",
"typeUniversityGrounds",
"typeDeprecatedTarmac",
"typeEnclosedTrafficArea",
"typeParkingLot",
"typeParkingGarage",
"typeOffRoadArea",
"typeBorder",
"typeBuilding",
"typeGeocodedAddress",
"typeNaturalFeature",
"typeTerrain",
"typeSand",
"typeBeach",
"typeDune",
"typeRocky",
"typeIce",
"typeGlacier",
"typeBuiltUpArea",
"typeVegetation",
"typeShrubbery",
"typeWoods",
"typeAgricultural",
"typeGrassland",
"typeTundra",
"typeDesert",
"typeSaltFlat",
"typeWater",
"typeOcean",
"typeBay",
"typeBight",
"typeLagoon",
"typeSea",
"typeStrait",
"typeInlet",
"typeFjord",
"typeLake",
"typeSeasonalLake",
"typeReservoir",
"typePond",
"typeRiver",
"typeRapids",
"typeDistributary",
"typeConfluence",
"typeWaterfall",
"typeSpring",
"typeGeyser",
"typeHotSpring",
"typeSeasonalRiver",
"typeWadi",
"typeEstuary",
"typeWetland",
"typeWaterNavigation",
"typeFord",
"typeCanal",
"typeHarbor",
"typeChannel",
"typeReef",
"typeReefFlat",
"typeReefGrowth",
"typeReefExtent",
"typeReefRockSubmerged",
"typeIrrigation",
"typeDam",
"typeDrinkingWater",
"typeCurrent",
"typeWateringHole",
"typeTectonic",
"typeWateringHoleDeprecated",
"typeVolcano",
"typeLavaField",
"typeFissure",
"typeFault",
"typeLandMass",
"typeContinent",
"typeIsland",
"typeAtoll",
"typeOceanRockExposed",
"typeCay",
"typePeninsula",
"typeIsthmus",
"typeElevated",
"typePeak",
"typeNunatak",
"typeSpur",
"typePass",
"typePlateau",
"typeRidge",
"typeRavine",
"typeCrater",
"typeKarst",
"typeCliff",
"typeVista",
"typeDigitalElevationModel",
"typeUpland",
"typeTerrace",
"typeSlope",
"typeContourLine",
"typePan",
"typeUnstableHillside",
"typeMountainRange",
"typeUndersea",
"typeSubmarineSeamount",
"typeSubmarineRidge",
"typeSubmarineGap",
"typeSubmarinePlateau",
"typeSubmarineDeep",
"typeSubmarineValley",
"typeSubmarineBasin",
"typeSubmarineSlope",
"typeSubmarineCliff",
"typeSubmarinePlain",
"typeSubmarineFractureZone",
"typeCave",
"typeRock",
"typeArchipelago",
"typePostal",
"typePostalCode",
"typePostalCodePrefix",
"typePremise",
"typeSubPremise",
"typeSuite",
"typePostTown",
"typePostalRound",
"typeMetaFeature",
"typeDataSource",
"typeLocale",
"typeTimezone",
"typeBusinessChain",
"typePhoneNumberPrefix",
"typePhoneNumberAreaCode",
"typeBusinessCorridor",
"typeAddressTemplate",
"typeEvent",
"typeEarthquake",
"typeHurricane",
"typeWeatherCondition",
"typeTransient",
"typeEntrance",
"typeCartographic",
"typeHighTension",
"typeSkiTrail",
"typeSkiLift",
"typeSkiBoundary",
"typeWatershedBoundary",
"typeTarmac",
"typeWall",
"typePicnicArea",
"typePlayGround",
"typeTrailHead",
"typeGolfTeeingGround",
"typeGolfPuttingGreen",
"typeGolfRough",
"typeGolfSandBunker",
"typeGolfFairway",
"typeGolfHole",
"typeDeprecatedGolfShop",
"typeCampingSite",
"typeDesignatedBarbecuePit",
"typeDesignatedCookingArea",
"typeCampfirePit",
"typeWaterFountain",
"typeLitterReceptacle",
"typeLockerArea",
"typeAnimalEnclosure",
"typeCartographicLine",
"typeEstablishment",
"typeEstablishmentGrounds",
"typeEstablishmentBuilding",
"typeEstablishmentPoi",
"typeEstablishmentService",
"typeCelestial",
"typeRoadMonitor",
"typePublicSpacesAndMonuments",
"typeStatue",
"typeTownSquare",
"typeLevel",
"typeCompound",
"typeCompoundGrounds",
"typeCompoundBuilding",
"typeCompoundSection",
"typeTerminalPoint",
"typeRegulatedArea",
"typeDoNotUseReservedToCatchGeneratedFiles",
"typeUnknown"
],
"enumDescriptions": [
"ABSTRACT",
"ABSTRACT",
"A route is any section of road (or rails, etc.) that has a name. This includes city streets as well as highways. Road segments can belong to multiple routes (e.g. El Camino, CA-82).",
"DEPRECATED",
"ABSTRACT",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"A designated bicycle route, whose segments may consist of any combination of bicycle paths, bicycle lanes, or city streets.",
"A designated trail, which may consist of paved walkways, dirt paths, fire road, streets or highways, etc.",
"ABSTRACT",
"",
"Railroads use several different incompatible track types.",
"",
"",
"",
"",
"",
"",
"",
"",
"Tracks for streetcars, cable-cars, etc. Ferries are services that are part of the road network but are not roads. They typically involve fares and scheduled departure times.",
"ABSTRACT",
"The vast majority of ferries are ferry boats.",
"Also called a \"car transport\", a ferry train is a rail service that carries passengers and their vehicles across undrivable terrain. The Channel Tunnel (\"Chunnel\") is the most famous example, but they are also common in the Alps where they connect neighboring valleys otherwise separated by impassable mountains.",
"Any plausible 1-dimensional path through a 2+ dimensional space, for the purposes of making graph-search-based routing possible. Such segments can be used to model paths through parking lots, squares, floors of buildings and other areas.",
"An intersection consists of a collection of segments that terminate at the same location. This is topological definition: it may not match what a typical user would think of as an \"intersection\". See TYPE_INTERSECTION_GROUP, below, for more information. Each segment terminating at an intersection has an \"endpoint type\" that specifies how that segment is terminated: stop sign, yield sign, three-way light, etc.",
"ABSTRACT",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"A transit line is a collection of transit legs, associated with some invariant properties of the trips that run over the legs. See also transitline.proto",
"A transit agency operates a number of lines, typically all in the same city, region or country. See also transitagency.proto",
"DEPRECATED",
"ABSTRACT",
"Road sign features have names, point geometry, etc. They also have segment_path data (see below) which lists the segments that refer to the sign. See segment.proto for the reference from the segment to the road sign.",
"Our TYPE_INTERSECTION feature, above, models the point where one or more segments terminate. This is topological definition: it may not match what a typical user would think of as an \"intersection\". Consider the intersections where Hayes, Market, Larkin, and 9th Street meet near (37.77765, -122.41638) in San Francisco. Most people would probably consider this a single feature, even though we model it as four separate TYPE_INTERSECTION features. This TYPE_INTERSECTION_GROUP is used to model the user's concept of a complex intersection.",
"RESERVED",
"A restriction group describes a set of segment restrictions that belong together and have a name or an associated event. See also restriction_group.proto",
"A toll cluster is either a single point on a segment (represented as a point at the end of the segment that has ENDPOINT_TOLL_BOOTH set) or a group of points on various road segments in MapFacts that represents one or more lanes passing through a toll fixture that all go to the same routing destination. Each toll cluster should have at most a single price per payment method. E.g. {CASH = $5, PASS = $1}. Note: If a toll fixture has different prices for multiple routing destinations, drivers need to be in the correct lane before passing through the toll fixture and hence such a fixture is represented by multiple toll clusters. A toll cluster does not necessarily represent a real-world entity, e.g. a particular plaza/structure as perceived by humans. This is because a plaza can be represented by more than one toll cluster. We require toll clusters to have names, but they might be non-unique. For example, a plaza might be represented by multiple toll clusters that may have the same plaza name. For further details, please see go/toll-cluster-schema.",
"ABSTRACT",
"",
"ABSTRACT",
"",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"",
"DEPRECATED",
"DEPRECATED",
"",
"",
"",
"",
"",
"",
"",
"e.g. Silicon Valley",
"A reservation is a region collectively held or governed by indigenous people and officially recognized by the country\u2019s government at the federal or state level. A reservation may be fully contained within an administrative feature or partially contained within two or more. These regions are referred to by different categorical names depending on country and even by state, including but not limited to: \u201cIndian Reservations\u201d, \u201cIndian Reserves\u201d, \u201cLand Claim Settlement Lands\u201d, \u201cIndian Lands\u201d, \u201cTreaty Lands\u201d, \u201cIndigenous Territories\u201d, etc. A reservation is not a historic indigenous territory boundary or a region which has applied for land rights but has not yet received official recognition.",
"",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"An entity widely considered to be a city, that may itself be made up of smaller political entities, some of which are cities/towns/villages themselves. For example, the colloquial view of Sydney, Australia actually comprises many smaller cities, but is regarded as a city itself. This type is not suitable for modeling official metro-/micropolitan or other statistical areas.",
"ABSTRACT",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"",
"",
"",
"",
"",
"",
"",
"Designated Market Areas (or DMAs) are used by marketing and ratings companies (such as the Nielsen Media Research company) to describe geographical regions (such as the greater New York metropolitan area) that are covered by a set of television stations. (See http://www.schooldata.com/pdfs/DMA.pdf) In the United States, DMAs should have a DMA numeric ID name, tagged with the FLAG_DESIGNATED_MARKET_AREA_ID flag.",
"",
"",
"Eventually we'll have more data for disputed areas (e.g., who makes claims on the area, who has de facto control, etc.). For the moment, we just define a type so we can simply mark areas as disputed.",
"Boundaries representing the jurisdiction of a particular police station.",
"An area used for aggregating statistical data, eg, a census region. Note that TYPE_STATISTICAL_AREA has a third nibble so we can add an abstract parent above it later if need be at 0x2E1 (and rename TYPE_STATISTICAL_AREA as TYPE_STATISTICAL_AREA1).",
"RESERVED",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"A line representing the boundary between two features. See border.proto for details.",
"DEPRECATED",
"An association of a point with an address, with no other information.",
"ABSTRACT",
"Expanses of land that share common surface attributes. These areas would look more or less uniform from a high altitude.",
"",
"",
"",
"",
"",
"",
"Terrain that looks populated.",
"Terrain that is covered in vegetation.",
"",
"",
"",
"",
"",
"",
"A flat expanse of salt left by the evaporation of a body of salt water.",
"Features can be TYPE_WATER if we don't have enough information to properly type the body of water. TYPE_WATER is also used as the type for child features that compose a TYPE_RIVER feature.",
"One of the large salt-water bodies that covers most of the globe.",
"An ocean subdivision formed by a coastal indentation. Includes coves and gulfs.",
"An open body of water formed by a slight coastal indentation.",
"",
"An ocean subdivision more or less confined by land and islands.",
"A long narrow ocean subdivision. Includes sounds.",
"",
"",
"An inland body of standing water.",
"A lake that dries up part of the year.",
"An artificial body of water, possibly created by a dam, often used for irrigation or house use.",
"",
"An inland body of moving water, or parts associated with it in which there is little or no current (backwater).",
"",
"A branch which flows away from the main river. Includes deltas.",
"A place where two or more rivers join.",
"",
"A place where ground water flows naturally out of the ground.",
"",
"",
"A river that dries up part of the year.",
"A dry riverbed that occasionally receives flashfloods.",
"A place at the end of a river where fresh and salt water mix. Includes tidal creeks and limans.",
"Land that is usually flooded. Includes bogs, marshes, flats, moors, and swamps.",
"",
"A shallow place where water may be waded through.",
"A narrow passage used by boats. Normally artificial.",
"A deep place near a shore where ships commonly drop anchor.",
"A deep part in a body of water that is suitable for navigation. Includes narrows.",
"Rocks, coral, sandbars, or other features beneath the surface of the water that pose a hazard to passing ships. Includes shoals.",
"A relatively shallow zone of the back reef located closest to the shore, that may be exposed at low tide.",
"A small section of rocks, coral, sandbars, or other features beneath the surface of the water that forms part of a reef.",
"The full extent of the reef complex.",
"A submerged rock in the water.",
"Man-made (and sometimes natural) channels used to move water. This type was used for both dam structures and water that is hold back by dams. We should use TYPE_COMPOUND_BUILDING for dam structures and TYPE_RESERVOIR for water.",
"DEPRECATED",
"",
"Includes overfalls.",
"A natural depression filled with water where animals come to drink.",
"ABSTRACT This type is incorrectly under TYPE_TECTONIC instead of TYPE_WATER. This was a mistake and is now fixed. See TYPE_WATERING_HOLE for the replacement.",
"DEPRECATED",
"",
"",
"",
"",
"",
"",
"",
"",
"An exposed rock in the water.",
"A small, low-elevation, sandy island formed on the surface of coral reefs",
"A stretch of land projecting into water. Includes capes and spits.",
"A strip of land connecting two larger land masses, such as continents.",
"Features that are notable for being high (or low), or for having sudden changes in elevation. These features might have an \"elevation\" extension to specify the actual elevation. See ElevationProto for more information.",
"Elevations that have a distinctive peak.",
"A peak or ridge of a mountain that extends through a glacier.",
"A subsidiary peak of a mountain.",
"A route over an otherwise difficult to traverse feature. Includes saddle.",
"Elevations that are flat on top. Includes mesas and buttes.",
"A ridge is a geographical feature consisting of a chain of mountains or hills that form a continuous elevated crest with a single ridgeline for some distance.",
"Steep declines usually carved by erosion. Includes valleys, canyons, ditches, and gorges.",
"Depressions causes by impact, explosion, and sometimes sink-holes.",
"Topography formed on limestone and gypsum by dissolution with sinkholes, caves, etc.",
"A vertical or nearly vertical slope. Includes escarpments.",
"An elevated place that is notable for having a good view. Raster digital elevation data. This is not a type to be used by providers or consumed by clients.",
"RESERVED",
"Land along streams higher than the alluvial plain or stream terrace.",
"",
"Land not so steep as a cliff, but changing elevation. Includes slides.",
"All the points on the polygon are at the same elevation.",
"A near-level shallow, natural depression or basin, usually containing an intermittent lake, pond, or pool.",
"",
"A series of mountains or hills ranged in a line and connected by high ground. Mountain ranges usually consist of many smaller ridges. For example, the Himalayas, the Andes. the Alps, etc.",
"Features that are notable for being high (or low), or for having sudden changes in elevation. These features might have an \"elevation\" extension to specify the actual elevation. See ElevationProto for more information.",
"includes peaks, ranges, and spurs",
"",
"includes saddles",
"",
"",
"includes trenches and troughs",
"",
"",
"",
"",
"",
"Don't use 0xA7. Use 8 bits for additional types under TYPE_NATURAL_FEATURE, so we don't run out of space. The following are miscellaneous natural features that don't fit any of the categories above.",
"",
"A feature representing a group or chain of islands. ",
"ABSTRACT",
"This is the type for postal codes which are complete and independent enough that there should be a feature for them (e.g. US 5-digit ZIP codes). For even more detailed suffixes that further subdivide a postal code (such as the +4 component in US ZIP codes), store the information in a TYPE_POSTAL_CODE_SUFFIX address component. When a range or set of postal codes share the same geographical area, e.g. because a precise subdivision does not exist or this subdivision is unknown, this type is used for each individual postal code.",
"A prefix portion of a postal code which does not meet the requirements for TYPE_POSTAL_CODE, but which is useful to search for, for example UK outcodes.",
"DEPRECATED",
"DEPRECATED This is deprecated and we want to use TYPE_COMPOUND_SECTION instead.",
"DEPRECATED",
"The term \"post town\" is used for a locality-like-entity that is only used for postal addresses.",
"DEPRECATED",
"ABSTRACT",
"Every data source used in constructing a data repository has a corresponding feature that provides more information about that data source. The extra information is stored in the optional data_source field below.",
"A locale feature provides region specific conventions such as preferred language and formatting details for time, date, and currency values. Locales aren't necessary defined by physical geographic features, so they are classified as meta-features.",
"A timezone feature is used to specify the region covering an international timezone. When a point is covered by multiple timezone features, the most specific one can be used to compute the local time at this point. Most specific implies a much smaller region or the one that is closer to the center. A feature's timezone can be specified in the repeated related_timezone field.",
"A business chain feature is used to represent a chain, e.g. Starbucks, McDonald's, etc. Other features representing specific stores/franchises of this chain may refer to one such feature via RELATION_MEMBER_OF_CHAIN. This is not strictly reserved to commercial chains but can also be used to model organizations such as the Red Cross or the United Nations.",
"A phone number prefix feature is used to specify the region where phone numbers (typically fixed-line numbers) must begin with a certain prefix. Any phone number prefix down to any level of granularity could be represented by this type.",
"A phone number area code is a prefix which also coincides with the area code, or national destination code, of a particular region.",
"A Business Corridor is a dense cluster of semantically similar establishments. TYPE_BUSINESS_CORRIDOR features are distinguished from TYPE_COLLOQUIAL_AREA features because the corridors are not under the political hierarchy, are allowed to be nameless, and may not correspond to well-known real world locations. For more details, see go/geo-corridors-schema.",
"An address template feature provides region-specific conventions for structuring addresses. These features aren't necessarily defined by physical geographic features, so they are classified as meta-features.",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"DEPRECATED",
"RESERVED",
"A portal of entry or exit to another feature. Examples: - Subway station entrance. - Parking lot entrance.",
"Cartographic features are used to capture real-world objects for which there is no current desire to model any specific attributes. These are only useful to make the map tiles look pretty.",
"DEPRECATED",
"Also see skitrail.proto",
"Also see skilift.proto",
"Also see skiboundary.proto",
"",
"Starting with TYPE_TARMAC, we use longer IDs, so that we can expand the number of feature types under TYPE_CARTOGRAPHIC.",
"Use TYPE_COMPOUND_GROUND and appropriate gcids for the next two.",
"DEPRECATED",
"DEPRECATED",
"",
"Sub-types within a golf course.",
"",
"",
"",
"",
"Use TYPE_ESTABLISHMENT_POI and gcid:golf_shop for golf shops instead.",
"DEPRECATED",
"DEPRECATED",
"",
"",
"",
"",
"",
"",
"Subtype within a zoo - a cage or fenced-off or otherwise delineated area containing animals.",
"A line for a cartographic detail. For example the international date line. Such features should have polyline geometry.",
"ABSTRACT This type is being replaced by TYPE_COMPOUND_GROUNDS. For further details, see go/compounds-v2",
"DEPRECATED This type has been replaced by TYPE_COMPOUND_BUILDING. For further details, see go/oyster-compounds",
"DEPRECATED",
"Establishment POIs can be referenced by TYPE_COMPOUND features using the RELATION_PRIMARILY_OCCUPIED_BY. This is the reciprocal relation of the RELATION_OCCUPIES.",
"Represents service-only establishments (those without a storefront location). NOTE(tcain): Using value 0xD441, since we could find ourselves with a need to differentiate service areas from online-only at this level in the future, but still benefit from being able to group those under a common parent, disjoint from TYPE_ESTABLISHMENT_POI.",
"The root of types of features that are in the sky, rather than on the earth. There will eventually be a hierarchy of types here.",
"Features responsible for monitoring traffic on roads (usually for speed). Includes cameras at particular points as well as monitors that cover larger spans. Features of this type should have a corresponding gcid that specifies the correct subtype (e.g. gcid:road_camera or gcid:speed_camera_zone). This type was originally named as TYPE_ROAD_CAMERA.",
"ABSTRACT",
"Note that this type does not distinguish the nature of the statue (religious, historical, memorial, tourist, ...).",
"Open space used for events, gathering, or as market-place.",
"A feature used to represent a logical level, e.g. floor.",
"ABSTRACT",
"e.g. campus, compound, parcel.",
"e.g. single family dwelling, office building.",
"e.g. suite, room, hallway, cubicle.",
"A terminal point represents a good location for a user to meet a taxi, ridesharing vehicle, or general driver.",
"An area controlled in some way by an authoritative source, such as a government-designated COVID containment zone. Features of this type should have one or more gcids corresponding to their specific regulation.",
"DEPRECATED",
"A feature of completely unknown type. This should only be used when absolutely necessary. One example in which this type is useful is in the Chinese importer, which must heuristically segment addresses into components - it often does not know what types to make those components. Please note that the Oyster address formatter does not currently support address components of TYPE_UNKNOWN well."
],
"type": "string"
},
"positionPrecisionMeters": {
"description": "Precision of the center point (lat/long) of the geocoded FeatureProto",
"format": "double",
"type": "number"
},
"queryString": {
"description": "The query sent to the geocoder",
"type": "string"
}
},
"type": "object"
},
"GeographicDivision": {
"description": "Describes a political geography.",
"id": "GeographicDivision",
@@ -871,6 +1664,12 @@
},
"type": "object"
},
"MessageSet": {
"description": "This is proto2's version of MessageSet.",
"id": "MessageSet",
"properties": {},
"type": "object"
},
"Office": {
"description": "Information about an Office held by one or more Officials.",
"id": "Office",
@@ -934,7 +1733,8 @@
"highestCourtJudge",
"judge",
"schoolBoard",
"specialPurposeOfficer"
"specialPurposeOfficer",
"otherRole"
],
"enumDescriptions": [
"",
@@ -947,6 +1747,7 @@
"",
"",
"",
"",
""
],
"type": "string"
@@ -988,6 +1789,13 @@
},
"type": "array"
},
"geocodingSummaries": {
"description": "Detailed summary about the official's address's geocoding",
"items": {
"$ref": "GeocodingSummary"
},
"type": "array"
},
"name": {
"description": "The official's name.",
"type": "string"

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

@@ -170,7 +170,7 @@
"courses": {
"methods": {
"create": {
"description": "Creates a course. The user specified in `ownerId` is the owner of the created course and added as a teacher. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create courses or for access errors. * `NOT_FOUND` if the primary teacher is not a valid user. * `FAILED_PRECONDITION` if the course owner's account is disabled or for the following request errors: * UserGroupsMembershipLimitReached * `ALREADY_EXISTS` if an alias was specified in the `id` and already exists.",
"description": "Creates a course. The user specified in `ownerId` is the owner of the created course and added as a teacher. A non-admin requesting user can only create a course with themselves as the owner. Domain admins can create courses owned by any user within their domain. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create courses or for access errors. * `NOT_FOUND` if the primary teacher is not a valid user. * `FAILED_PRECONDITION` if the course owner's account is disabled or for the following request errors: * UserGroupsMembershipLimitReached * `ALREADY_EXISTS` if an alias was specified in the `id` and already exists.",
"flatPath": "v1/courses",
"httpMethod": "POST",
"id": "classroom.courses.create",
@@ -1471,7 +1471,7 @@
"students": {
"methods": {
"create": {
"description": "Adds a user as a student of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create students in this course or for access errors. * `NOT_FOUND` if the requested course ID does not exist. * `FAILED_PRECONDITION` if the requested user's account is disabled, for the following request errors: * CourseMemberLimitReached * CourseNotModifiable * UserGroupsMembershipLimitReached * `ALREADY_EXISTS` if the user is already a student or teacher in the course.",
"description": "Adds a user as a student of a course. Domain administrators are permitted to [directly add](https://developers.google.com/classroom/guides/manage-users) users within their domain as students to courses within their domain. Students are permitted to add themselves to a course using an enrollment code. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create students in this course or for access errors. * `NOT_FOUND` if the requested course ID does not exist. * `FAILED_PRECONDITION` if the requested user's account is disabled, for the following request errors: * CourseMemberLimitReached * CourseNotModifiable * UserGroupsMembershipLimitReached * `ALREADY_EXISTS` if the user is already a student or teacher in the course.",
"flatPath": "v1/courses/{courseId}/students",
"httpMethod": "POST",
"id": "classroom.courses.students.create",
@@ -1612,7 +1612,7 @@
"teachers": {
"methods": {
"create": {
"description": "Creates a teacher of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create teachers in this course or for access errors. * `NOT_FOUND` if the requested course ID does not exist. * `FAILED_PRECONDITION` if the requested user's account is disabled, for the following request errors: * CourseMemberLimitReached * CourseNotModifiable * CourseTeacherLimitReached * UserGroupsMembershipLimitReached * `ALREADY_EXISTS` if the user is already a teacher or student in the course.",
"description": "Creates a teacher of a course. Domain administrators are permitted to [directly add](https://developers.google.com/classroom/guides/manage-users) users within their domain as teachers to courses within their domain. Non-admin users should send an Invitation instead. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create teachers in this course or for access errors. * `NOT_FOUND` if the requested course ID does not exist. * `FAILED_PRECONDITION` if the requested user's account is disabled, for the following request errors: * CourseMemberLimitReached * CourseNotModifiable * CourseTeacherLimitReached * UserGroupsMembershipLimitReached * `ALREADY_EXISTS` if the user is already a teacher or student in the course.",
"flatPath": "v1/courses/{courseId}/teachers",
"httpMethod": "POST",
"id": "classroom.courses.teachers.create",
@@ -1641,7 +1641,7 @@
]
},
"delete": {
"description": "Deletes a teacher of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete teachers of this course or for access errors. * `NOT_FOUND` if no teacher of this course has the requested ID or if the course does not exist. * `FAILED_PRECONDITION` if the requested ID belongs to the primary teacher of this course.",
"description": "Removes the specified teacher from the specified course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete teachers of this course or for access errors. * `NOT_FOUND` if no teacher of this course has the requested ID or if the course does not exist. * `FAILED_PRECONDITION` if the requested ID belongs to the primary teacher of this course. * `FAILED_PRECONDITION` if the requested ID belongs to the owner of the course Drive folder. * `FAILED_PRECONDITION` if the course no longer has an active owner.",
"flatPath": "v1/courses/{courseId}/teachers/{userId}",
"httpMethod": "DELETE",
"id": "classroom.courses.teachers.delete",
@@ -2400,7 +2400,7 @@
}
}
},
"revision": "20210323",
"revision": "20220224",
"rootUrl": "https://classroom.googleapis.com/",
"schemas": {
"Announcement": {
@@ -2605,6 +2605,10 @@
"description": "Enrollment code to use when joining this course. Specifying this field in a course update mask results in an error. Read-only.",
"type": "string"
},
"gradebookSettings": {
"$ref": "GradebookSettings",
"description": "The gradebook settings that specify how a student's overall grade for the course will be calculated and who it will be displayed to. Read-only"
},
"guardiansEnabled": {
"description": "Whether or not guardian notifications are enabled for this course. Read-only.",
"type": "boolean"
@@ -2763,6 +2767,10 @@
"$ref": "TimeOfDay",
"description": "Optional time of day, in UTC, that submissions for this course work are due. This must be specified if `due_date` is specified."
},
"gradeCategory": {
"$ref": "GradeCategory",
"description": "The category that this coursework's grade contributes to. Present only when a category has been chosen for the coursework. May be used in calculating the overall grade. Read-only."
},
"id": {
"description": "Classroom-assigned identifier of this course work, unique per course. Read-only.",
"type": "string"
@@ -2957,7 +2965,7 @@
"type": "object"
},
"Date": {
"description": "Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.",
"description": "Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day, with a zero year (e.g., an anniversary) * A year on its own, with a zero month and a zero day * A year and month, with a zero day (e.g., a credit card expiration date) Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp",
"id": "Date",
"properties": {
"day": {
@@ -3099,6 +3107,31 @@
},
"type": "object"
},
"GradeCategory": {
"description": "Details for a grade category in a course. Coursework may have zero or one grade category, and the category may be used in computing the overall grade. See the [help center article](https://support.google.com/edu/classroom/answer/9184995) for details.",
"id": "GradeCategory",
"properties": {
"defaultGradeDenominator": {
"description": "Default value of denominator. Only applicable when grade calculation type is TOTAL_POINTS.",
"format": "int32",
"type": "integer"
},
"id": {
"description": "ID of the grade category.",
"type": "string"
},
"name": {
"description": "Name of the grade category.",
"type": "string"
},
"weight": {
"description": "The weight of the category average as part of overall average. A weight of 12.34% is represented as 123400 (100% is 1,000,000). The last two digits should always be zero since we use two decimal precision. Only applicable when grade calculation type is WEIGHTED_CATEGORIES.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GradeHistory": {
"description": "The history of each grade on this submission.",
"id": "GradeHistory",
@@ -3141,6 +3174,50 @@
},
"type": "object"
},
"GradebookSettings": {
"description": "The gradebook settings for a course. See the [help center article](https://support.google.com/edu/classroom/answer/9184995) for details.",
"id": "GradebookSettings",
"properties": {
"calculationType": {
"description": "Indicates how the overall grade is calculated.",
"enum": [
"CALCULATION_TYPE_UNSPECIFIED",
"TOTAL_POINTS",
"WEIGHTED_CATEGORIES"
],
"enumDescriptions": [
"No method specified. This is never returned.",
"Overall grade is the sum of grades divided by the sum of total points regardless of category.",
"Overall grade is the weighted average by category."
],
"type": "string"
},
"displaySetting": {
"description": "Indicates who can see the overall grade..",
"enum": [
"DISPLAY_SETTING_UNSPECIFIED",
"SHOW_OVERALL_GRADE",
"HIDE_OVERALL_GRADE",
"SHOW_TEACHERS_ONLY"
],
"enumDescriptions": [
"No setting specified. This is never returned.",
"Shows overall grade in the gradebook and student profile to both teachers and students.",
"Does not show overall grade in the gradebook or student profile.",
"Shows the overall grade to teachers in the gradebook and student profile. Hides from students in their student profile."
],
"type": "string"
},
"gradeCategories": {
"description": "Grade categories that are available for coursework in the course.",
"items": {
"$ref": "GradeCategory"
},
"type": "array"
}
},
"type": "object"
},
"Guardian": {
"description": "Association between a student and a guardian of that student. The guardian may receive information about the student's course work.",
"id": "Guardian",

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

File diff suppressed because it is too large Load Diff

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

@@ -3,7 +3,7 @@
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "View and manage your data across Google Cloud Platform services"
"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
}
}
}
@@ -411,9 +411,22 @@
}
}
},
"revision": "20210319",
"revision": "20220225",
"rootUrl": "https://cloudasset.googleapis.com/",
"schemas": {
"AnalyzeIamPolicyLongrunningMetadata": {
"description": "Represents the metadata of the longrunning operation for the AnalyzeIamPolicyLongrunning rpc.",
"id": "AnalyzeIamPolicyLongrunningMetadata",
"properties": {
"createTime": {
"description": "Output only. The time the operation was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"AnalyzeIamPolicyLongrunningResponse": {
"description": "A response message for AssetService.AnalyzeIamPolicyLongrunning.",
"id": "AnalyzeIamPolicyLongrunningResponse",
@@ -525,22 +538,22 @@
"type": "object"
},
"Binding": {
"description": "Associates `members` with a `role`.",
"description": "Associates `members`, or principals, with a `role`.",
"id": "Binding",
"properties": {
"condition": {
"$ref": "Expr",
"description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)."
"description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)."
},
"members": {
"description": "Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ",
"description": "Specifies the principals requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ",
"items": {
"type": "string"
},
"type": "array"
},
"role": {
"description": "Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.",
"description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.",
"type": "string"
}
},
@@ -896,7 +909,7 @@
"type": "string"
},
"name": {
"description": "Required. Resource name for the Access Level. The `short_name` component must begin with a letter and only include alphanumeric and '_'. Format: `accessPolicies/{policy_id}/accessLevels/{short_name}`. The maximum length of the `short_name` component is 50 characters.",
"description": "Required. Resource name for the Access Level. The `short_name` component must begin with a letter and only include alphanumeric and '_'. Format: `accessPolicies/{access_policy}/accessLevels/{access_level}`. The maximum length of the `access_level` component is 50 characters.",
"type": "string"
},
"title": {
@@ -915,13 +928,20 @@
"type": "string"
},
"name": {
"description": "Output only. Resource name of the `AccessPolicy`. Format: `accessPolicies/{policy_id}`",
"description": "Output only. Resource name of the `AccessPolicy`. Format: `accessPolicies/{access_policy}`",
"type": "string"
},
"parent": {
"description": "Required. The parent of this `AccessPolicy` in the Cloud Resource Hierarchy. Currently immutable once created. Format: `organizations/{organization_id}`",
"type": "string"
},
"scopes": {
"description": "The scopes of a policy define which resources an ACM policy can restrict, and where ACM resources can be referenced. For example, a policy with scopes=[\"folders/123\"] has the following behavior: - vpcsc perimeters can only restrict projects within folders/123 - access levels can only be referenced by resources within folders/123. If empty, there are no limitations on which resources can be restricted by an ACM policy, and there are no limitations on where ACM resources can be referenced. Only one policy can include a given scope (attempting to create a second policy which includes \"folders/123\" will result in an error). Currently, scopes cannot be modified after a policy is created. Currently, policies can only have a single scope. Format: list of `folders/{folder_number}` or `projects/{project_number}`",
"items": {
"type": "string"
},
"type": "array"
},
"title": {
"description": "Required. Human readable title. Does not affect behavior.",
"type": "string"
@@ -1092,7 +1112,7 @@
"type": "object"
},
"GoogleIdentityAccesscontextmanagerV1EgressFrom": {
"description": "Defines the conditions under which an EgressPolicy matches a request. Conditions based on information about the source of the request. Note that if the destination of the request is protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed.",
"description": "Defines the conditions under which an EgressPolicy matches a request. Conditions based on information about the source of the request. Note that if the destination of the request is also protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed.",
"id": "GoogleIdentityAccesscontextmanagerV1EgressFrom",
"properties": {
"identities": {
@@ -1137,18 +1157,18 @@
"type": "object"
},
"GoogleIdentityAccesscontextmanagerV1EgressTo": {
"description": "Defines the conditions under which an EgressPolicy matches a request. Conditions are based on information about the ApiOperation intended to be performed on the `resources` specified. Note that if the destination of the request is protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed.",
"description": "Defines the conditions under which an EgressPolicy matches a request. Conditions are based on information about the ApiOperation intended to be performed on the `resources` specified. Note that if the destination of the request is also protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed. The request must match `operations` AND `resources` fields in order to be allowed egress out of the perimeter.",
"id": "GoogleIdentityAccesscontextmanagerV1EgressTo",
"properties": {
"operations": {
"description": "A list of ApiOperations that this egress rule applies to. A request matches if it contains an operation/service in this list.",
"description": "A list of ApiOperations allowed to be performed by the sources specified in the corresponding EgressFrom. A request matches if it uses an operation/service in this list.",
"items": {
"$ref": "GoogleIdentityAccesscontextmanagerV1ApiOperation"
},
"type": "array"
},
"resources": {
"description": "A list of resources, currently only projects in the form `projects/`, that match this to stanza. A request matches if it contains a resource in this list. If `*` is specified for resources, then this EgressTo rule will authorize access to all resources outside the perimeter.",
"description": "A list of resources, currently only projects in the form `projects/`, that are allowed to be accessed by sources defined in the corresponding EgressFrom. A request matches if it contains a resource in this list. If `*` is specified for `resources`, then this EgressTo rule will authorize access to all resources outside the perimeter.",
"items": {
"type": "string"
},
@@ -1158,7 +1178,7 @@
"type": "object"
},
"GoogleIdentityAccesscontextmanagerV1IngressFrom": {
"description": "Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the source of the request.",
"description": "Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the source of the request. The request must satisfy what is defined in `sources` AND identity related fields in order to match.",
"id": "GoogleIdentityAccesscontextmanagerV1IngressFrom",
"properties": {
"identities": {
@@ -1214,7 +1234,7 @@
"id": "GoogleIdentityAccesscontextmanagerV1IngressSource",
"properties": {
"accessLevel": {
"description": "An AccessLevel resource name that allow resources within the ServicePerimeters to be accessed from the internet. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If no AccessLevel names are listed, resources within the perimeter can only be accessed via Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If `*` is specified, then all IngressSources will be allowed.",
"description": "An AccessLevel resource name that allow resources within the ServicePerimeters to be accessed from the internet. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If no AccessLevel names are listed, resources within the perimeter can only be accessed via Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all IngressSources will be allowed.",
"type": "string"
},
"resource": {
@@ -1225,18 +1245,18 @@
"type": "object"
},
"GoogleIdentityAccesscontextmanagerV1IngressTo": {
"description": "Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the ApiOperation intended to be performed on the destination of the request.",
"description": "Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the ApiOperation intended to be performed on the target resource of the request. The request must satisfy what is defined in `operations` AND `resources` in order to match.",
"id": "GoogleIdentityAccesscontextmanagerV1IngressTo",
"properties": {
"operations": {
"description": "A list of ApiOperations the sources specified in corresponding IngressFrom are allowed to perform in this ServicePerimeter.",
"description": "A list of ApiOperations allowed to be performed by the sources specified in corresponding IngressFrom in this ServicePerimeter.",
"items": {
"$ref": "GoogleIdentityAccesscontextmanagerV1ApiOperation"
},
"type": "array"
},
"resources": {
"description": "A list of resources, currently only projects in the form `projects/`, protected by this ServicePerimeter that are allowed to be accessed by sources defined in the corresponding IngressFrom. A request matches if it contains a resource in this list. If `*` is specified for resources, then this IngressTo rule will authorize access to all resources inside the perimeter, provided that the request also matches the `operations` field.",
"description": "A list of resources, currently only projects in the form `projects/`, protected by this ServicePerimeter that are allowed to be accessed by sources defined in the corresponding IngressFrom. If a single `*` is specified, then access to all resources inside the perimeter are allowed.",
"items": {
"type": "string"
},
@@ -1306,7 +1326,7 @@
"type": "string"
},
"name": {
"description": "Required. Resource name for the ServicePerimeter. The `short_name` component must begin with a letter and only include alphanumeric and '_'. Format: `accessPolicies/{policy_id}/servicePerimeters/{short_name}`",
"description": "Required. Resource name for the ServicePerimeter. The `short_name` component must begin with a letter and only include alphanumeric and '_'. Format: `accessPolicies/{access_policy}/servicePerimeters/{service_perimeter}`",
"type": "string"
},
"perimeterType": {
@@ -1451,7 +1471,7 @@
"type": "object"
},
"Policy": {
"description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).",
"description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).",
"id": "Policy",
"properties": {
"auditConfigs": {
@@ -1462,7 +1482,7 @@
"type": "array"
},
"bindings": {
"description": "Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.",
"description": "Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.",
"items": {
"$ref": "Binding"
},

74
etc/api/cloudasset/v1p1beta1/cloudasset-api.json
View File

@@ -3,7 +3,7 @@
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "View and manage your data across Google Cloud Platform services"
"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
}
}
}
@@ -207,9 +207,22 @@
}
}
},
"revision": "20210319",
"revision": "20220225",
"rootUrl": "https://cloudasset.googleapis.com/",
"schemas": {
"AnalyzeIamPolicyLongrunningMetadata": {
"description": "Represents the metadata of the longrunning operation for the AnalyzeIamPolicyLongrunning rpc.",
"id": "AnalyzeIamPolicyLongrunningMetadata",
"properties": {
"createTime": {
"description": "Output only. The time the operation was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"AnalyzeIamPolicyLongrunningResponse": {
"description": "A response message for AssetService.AnalyzeIamPolicyLongrunning.",
"id": "AnalyzeIamPolicyLongrunningResponse",
@@ -265,22 +278,22 @@
"type": "object"
},
"Binding": {
"description": "Associates `members` with a `role`.",
"description": "Associates `members`, or principals, with a `role`.",
"id": "Binding",
"properties": {
"condition": {
"$ref": "Expr",
"description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)."
"description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)."
},
"members": {
"description": "Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ",
"description": "Specifies the principals requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ",
"items": {
"type": "string"
},
"type": "array"
},
"role": {
"description": "Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.",
"description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.",
"type": "string"
}
},
@@ -294,7 +307,7 @@
"additionalProperties": {
"$ref": "Permissions"
},
"description": "The map from roles to their included permission matching the permission query (e.g. containing `policy.role.permissions:`). A sample role string: \"roles/compute.instanceAdmin\". The roles can also be found in the returned `policy` bindings. Note that the map is populated only if requesting with a permission query.",
"description": "The map from roles to their included permission matching the permission query (e.g. containing `policy.role.permissions:`). Example role string: \"roles/compute.instanceAdmin\". The roles can also be found in the returned `policy` bindings. Note that the map is populated only if requesting with a permission query.",
"type": "object"
}
},
@@ -598,7 +611,7 @@
"type": "string"
},
"name": {
"description": "Required. Resource name for the Access Level. The `short_name` component must begin with a letter and only include alphanumeric and '_'. Format: `accessPolicies/{policy_id}/accessLevels/{short_name}`. The maximum length of the `short_name` component is 50 characters.",
"description": "Required. Resource name for the Access Level. The `short_name` component must begin with a letter and only include alphanumeric and '_'. Format: `accessPolicies/{access_policy}/accessLevels/{access_level}`. The maximum length of the `access_level` component is 50 characters.",
"type": "string"
},
"title": {
@@ -617,13 +630,20 @@
"type": "string"
},
"name": {
"description": "Output only. Resource name of the `AccessPolicy`. Format: `accessPolicies/{policy_id}`",
"description": "Output only. Resource name of the `AccessPolicy`. Format: `accessPolicies/{access_policy}`",
"type": "string"
},
"parent": {
"description": "Required. The parent of this `AccessPolicy` in the Cloud Resource Hierarchy. Currently immutable once created. Format: `organizations/{organization_id}`",
"type": "string"
},
"scopes": {
"description": "The scopes of a policy define which resources an ACM policy can restrict, and where ACM resources can be referenced. For example, a policy with scopes=[\"folders/123\"] has the following behavior: - vpcsc perimeters can only restrict projects within folders/123 - access levels can only be referenced by resources within folders/123. If empty, there are no limitations on which resources can be restricted by an ACM policy, and there are no limitations on where ACM resources can be referenced. Only one policy can include a given scope (attempting to create a second policy which includes \"folders/123\" will result in an error). Currently, scopes cannot be modified after a policy is created. Currently, policies can only have a single scope. Format: list of `folders/{folder_number}` or `projects/{project_number}`",
"items": {
"type": "string"
},
"type": "array"
},
"title": {
"description": "Required. Human readable title. Does not affect behavior.",
"type": "string"
@@ -794,7 +814,7 @@
"type": "object"
},
"GoogleIdentityAccesscontextmanagerV1EgressFrom": {
"description": "Defines the conditions under which an EgressPolicy matches a request. Conditions based on information about the source of the request. Note that if the destination of the request is protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed.",
"description": "Defines the conditions under which an EgressPolicy matches a request. Conditions based on information about the source of the request. Note that if the destination of the request is also protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed.",
"id": "GoogleIdentityAccesscontextmanagerV1EgressFrom",
"properties": {
"identities": {
@@ -839,18 +859,18 @@
"type": "object"
},
"GoogleIdentityAccesscontextmanagerV1EgressTo": {
"description": "Defines the conditions under which an EgressPolicy matches a request. Conditions are based on information about the ApiOperation intended to be performed on the `resources` specified. Note that if the destination of the request is protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed.",
"description": "Defines the conditions under which an EgressPolicy matches a request. Conditions are based on information about the ApiOperation intended to be performed on the `resources` specified. Note that if the destination of the request is also protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed. The request must match `operations` AND `resources` fields in order to be allowed egress out of the perimeter.",
"id": "GoogleIdentityAccesscontextmanagerV1EgressTo",
"properties": {
"operations": {
"description": "A list of ApiOperations that this egress rule applies to. A request matches if it contains an operation/service in this list.",
"description": "A list of ApiOperations allowed to be performed by the sources specified in the corresponding EgressFrom. A request matches if it uses an operation/service in this list.",
"items": {
"$ref": "GoogleIdentityAccesscontextmanagerV1ApiOperation"
},
"type": "array"
},
"resources": {
"description": "A list of resources, currently only projects in the form `projects/`, that match this to stanza. A request matches if it contains a resource in this list. If `*` is specified for resources, then this EgressTo rule will authorize access to all resources outside the perimeter.",
"description": "A list of resources, currently only projects in the form `projects/`, that are allowed to be accessed by sources defined in the corresponding EgressFrom. A request matches if it contains a resource in this list. If `*` is specified for `resources`, then this EgressTo rule will authorize access to all resources outside the perimeter.",
"items": {
"type": "string"
},
@@ -860,7 +880,7 @@
"type": "object"
},
"GoogleIdentityAccesscontextmanagerV1IngressFrom": {
"description": "Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the source of the request.",
"description": "Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the source of the request. The request must satisfy what is defined in `sources` AND identity related fields in order to match.",
"id": "GoogleIdentityAccesscontextmanagerV1IngressFrom",
"properties": {
"identities": {
@@ -916,7 +936,7 @@
"id": "GoogleIdentityAccesscontextmanagerV1IngressSource",
"properties": {
"accessLevel": {
"description": "An AccessLevel resource name that allow resources within the ServicePerimeters to be accessed from the internet. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If no AccessLevel names are listed, resources within the perimeter can only be accessed via Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If `*` is specified, then all IngressSources will be allowed.",
"description": "An AccessLevel resource name that allow resources within the ServicePerimeters to be accessed from the internet. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If no AccessLevel names are listed, resources within the perimeter can only be accessed via Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all IngressSources will be allowed.",
"type": "string"
},
"resource": {
@@ -927,18 +947,18 @@
"type": "object"
},
"GoogleIdentityAccesscontextmanagerV1IngressTo": {
"description": "Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the ApiOperation intended to be performed on the destination of the request.",
"description": "Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the ApiOperation intended to be performed on the target resource of the request. The request must satisfy what is defined in `operations` AND `resources` in order to match.",
"id": "GoogleIdentityAccesscontextmanagerV1IngressTo",
"properties": {
"operations": {
"description": "A list of ApiOperations the sources specified in corresponding IngressFrom are allowed to perform in this ServicePerimeter.",
"description": "A list of ApiOperations allowed to be performed by the sources specified in corresponding IngressFrom in this ServicePerimeter.",
"items": {
"$ref": "GoogleIdentityAccesscontextmanagerV1ApiOperation"
},
"type": "array"
},
"resources": {
"description": "A list of resources, currently only projects in the form `projects/`, protected by this ServicePerimeter that are allowed to be accessed by sources defined in the corresponding IngressFrom. A request matches if it contains a resource in this list. If `*` is specified for resources, then this IngressTo rule will authorize access to all resources inside the perimeter, provided that the request also matches the `operations` field.",
"description": "A list of resources, currently only projects in the form `projects/`, protected by this ServicePerimeter that are allowed to be accessed by sources defined in the corresponding IngressFrom. If a single `*` is specified, then access to all resources inside the perimeter are allowed.",
"items": {
"type": "string"
},
@@ -1008,7 +1028,7 @@
"type": "string"
},
"name": {
"description": "Required. Resource name for the ServicePerimeter. The `short_name` component must begin with a letter and only include alphanumeric and '_'. Format: `accessPolicies/{policy_id}/servicePerimeters/{short_name}`",
"description": "Required. Resource name for the ServicePerimeter. The `short_name` component must begin with a letter and only include alphanumeric and '_'. Format: `accessPolicies/{access_policy}/servicePerimeters/{service_perimeter}`",
"type": "string"
},
"perimeterType": {
@@ -1107,19 +1127,19 @@
"type": "object"
},
"IamPolicySearchResult": {
"description": "The result for a IAM Policy search.",
"description": "The result for an IAM policy search.",
"id": "IamPolicySearchResult",
"properties": {
"explanation": {
"$ref": "Explanation",
"description": "Explanation about the IAM policy search result. It contains additional information to explain why the search result matches the query."
"description": "Explanation about the IAM policy search result. It contains additional information that explains why the search result matches the query."
},
"policy": {
"$ref": "Policy",
"description": "The IAM policy directly set on the given resource. Note that the original IAM policy can contain multiple bindings. This only contains the bindings that match the given query. For queries that don't contain a constrain on policies (e.g. an empty query), this contains all the bindings."
"description": "The IAM policy attached to the specified resource. Note that the original IAM policy can contain multiple bindings. This only contains the bindings that match the given query. For queries that don't contain a constraint on policies (e.g. an empty query), this contains all the bindings."
},
"project": {
"description": "The project that the associated GCP resource belongs to, in the form of `projects/{project_number}`. If an IAM policy is set on a resource (like VM instance, Cloud Storage bucket), the project field will indicate the project that contains the resource. If an IAM policy is set on a folder or orgnization, the project field will be empty.",
"description": "The project that the associated Google Cloud resource belongs to, in the form of `projects/{project_number}`. If an IAM policy is set on a resource -- such as a Compute Engine instance or a Cloud Storage bucket -- the project field will indicate the project that contains the resource. If an IAM policy is set on a folder or orgnization, the project field will be empty.",
"type": "string"
},
"resource": {
@@ -1130,11 +1150,11 @@
"type": "object"
},
"Permissions": {
"description": "IAM permissions",
"description": "IAM permissions.",
"id": "Permissions",
"properties": {
"permissions": {
"description": "A list of permissions. A sample permission string: \"compute.disk.get\".",
"description": "A list of permissions. Example permission string: \"compute.disk.get\".",
"items": {
"type": "string"
},
@@ -1144,7 +1164,7 @@
"type": "object"
},
"Policy": {
"description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).",
"description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).",
"id": "Policy",
"properties": {
"auditConfigs": {
@@ -1155,7 +1175,7 @@
"type": "array"
},
"bindings": {
"description": "Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.",
"description": "Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.",
"items": {
"$ref": "Binding"
},

62
etc/api/cloudasset/v1p4beta1/cloudasset-api.json
View File

@@ -3,7 +3,7 @@
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "View and manage your data across Google Cloud Platform services"
"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
}
}
}
@@ -221,7 +221,7 @@
}
}
},
"revision": "20210319",
"revision": "20220225",
"rootUrl": "https://cloudasset.googleapis.com/",
"schemas": {
"AccessSelector": {
@@ -245,6 +245,19 @@
},
"type": "object"
},
"AnalyzeIamPolicyLongrunningMetadata": {
"description": "Represents the metadata of the longrunning operation for the AnalyzeIamPolicyLongrunning rpc.",
"id": "AnalyzeIamPolicyLongrunningMetadata",
"properties": {
"createTime": {
"description": "Output only. The time the operation was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"AnalyzeIamPolicyLongrunningResponse": {
"description": "A response message for AssetService.AnalyzeIamPolicyLongrunning.",
"id": "AnalyzeIamPolicyLongrunningResponse",
@@ -329,22 +342,22 @@
"type": "object"
},
"Binding": {
"description": "Associates `members` with a `role`.",
"description": "Associates `members`, or principals, with a `role`.",
"id": "Binding",
"properties": {
"condition": {
"$ref": "Expr",
"description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)."
"description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)."
},
"members": {
"description": "Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ",
"description": "Specifies the principals requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ",
"items": {
"type": "string"
},
"type": "array"
},
"role": {
"description": "Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.",
"description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.",
"type": "string"
}
},
@@ -490,7 +503,7 @@
"The caller does not have permission to execute the specified operation. `PERMISSION_DENIED` must not be used for rejections caused by exhausting some resource (use `RESOURCE_EXHAUSTED` instead for those errors). `PERMISSION_DENIED` must not be used if the caller can not be identified (use `UNAUTHENTICATED` instead for those errors). This error code does not imply the request is valid or the requested entity exists or satisfies other pre-conditions. HTTP Mapping: 403 Forbidden",
"The request does not have valid authentication credentials for the operation. HTTP Mapping: 401 Unauthorized",
"Some resource has been exhausted, perhaps a per-user quota, or perhaps the entire file system is out of space. HTTP Mapping: 429 Too Many Requests",
"The operation was rejected because the system is not in a state required for the operation's execution. For example, the directory to be deleted is non-empty, an rmdir operation is applied to a non-directory, etc. Service implementors can use the following guidelines to decide between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`: (a) Use `UNAVAILABLE` if the client can retry just the failing call. (b) Use `ABORTED` if the client should retry at a higher level (e.g., when a client-specified test-and-set fails, indicating the client should restart a read-modify-write sequence). (c) Use `FAILED_PRECONDITION` if the client should not retry until the system state has been explicitly fixed. E.g., if an \"rmdir\" fails because the directory is non-empty, `FAILED_PRECONDITION` should be returned since the client should not retry unless the files are deleted from the directory. HTTP Mapping: 400 Bad Request",
"The operation was rejected because the system is not in a state required for the operation's execution. For example, the directory to be deleted is non-empty, an rmdir operation is applied to a non-directory, etc. Service implementors can use the following guidelines to decide between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`: (a) Use `UNAVAILABLE` if the client can retry just the failing call. (b) Use `ABORTED` if the client should retry at a higher level. For example, when a client-specified test-and-set fails, indicating the client should restart a read-modify-write sequence. (c) Use `FAILED_PRECONDITION` if the client should not retry until the system state has been explicitly fixed. For example, if an \"rmdir\" fails because the directory is non-empty, `FAILED_PRECONDITION` should be returned since the client should not retry unless the files are deleted from the directory. HTTP Mapping: 400 Bad Request",
"The operation was aborted, typically due to a concurrency issue such as a sequencer check failure or transaction abort. See the guidelines above for deciding between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`. HTTP Mapping: 409 Conflict",
"The operation was attempted past the valid range. E.g., seeking or reading past end-of-file. Unlike `INVALID_ARGUMENT`, this error indicates a problem that may be fixed if the system state changes. For example, a 32-bit file system will generate `INVALID_ARGUMENT` if asked to read at an offset that is not in the range [0,2^32-1], but it will generate `OUT_OF_RANGE` if asked to read from an offset past the current file size. There is a fair bit of overlap between `FAILED_PRECONDITION` and `OUT_OF_RANGE`. We recommend using `OUT_OF_RANGE` (the more specific error) when it applies so that callers who are iterating through a space can easily look for an `OUT_OF_RANGE` error to detect when they are done. HTTP Mapping: 400 Bad Request",
"The operation is not implemented or is not supported/enabled in this service. HTTP Mapping: 501 Not Implemented",
@@ -843,7 +856,7 @@
"type": "string"
},
"name": {
"description": "Required. Resource name for the Access Level. The `short_name` component must begin with a letter and only include alphanumeric and '_'. Format: `accessPolicies/{policy_id}/accessLevels/{short_name}`. The maximum length of the `short_name` component is 50 characters.",
"description": "Required. Resource name for the Access Level. The `short_name` component must begin with a letter and only include alphanumeric and '_'. Format: `accessPolicies/{access_policy}/accessLevels/{access_level}`. The maximum length of the `access_level` component is 50 characters.",
"type": "string"
},
"title": {
@@ -862,13 +875,20 @@
"type": "string"
},
"name": {
"description": "Output only. Resource name of the `AccessPolicy`. Format: `accessPolicies/{policy_id}`",
"description": "Output only. Resource name of the `AccessPolicy`. Format: `accessPolicies/{access_policy}`",
"type": "string"
},
"parent": {
"description": "Required. The parent of this `AccessPolicy` in the Cloud Resource Hierarchy. Currently immutable once created. Format: `organizations/{organization_id}`",
"type": "string"
},
"scopes": {
"description": "The scopes of a policy define which resources an ACM policy can restrict, and where ACM resources can be referenced. For example, a policy with scopes=[\"folders/123\"] has the following behavior: - vpcsc perimeters can only restrict projects within folders/123 - access levels can only be referenced by resources within folders/123. If empty, there are no limitations on which resources can be restricted by an ACM policy, and there are no limitations on where ACM resources can be referenced. Only one policy can include a given scope (attempting to create a second policy which includes \"folders/123\" will result in an error). Currently, scopes cannot be modified after a policy is created. Currently, policies can only have a single scope. Format: list of `folders/{folder_number}` or `projects/{project_number}`",
"items": {
"type": "string"
},
"type": "array"
},
"title": {
"description": "Required. Human readable title. Does not affect behavior.",
"type": "string"
@@ -1039,7 +1059,7 @@
"type": "object"
},
"GoogleIdentityAccesscontextmanagerV1EgressFrom": {
"description": "Defines the conditions under which an EgressPolicy matches a request. Conditions based on information about the source of the request. Note that if the destination of the request is protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed.",
"description": "Defines the conditions under which an EgressPolicy matches a request. Conditions based on information about the source of the request. Note that if the destination of the request is also protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed.",
"id": "GoogleIdentityAccesscontextmanagerV1EgressFrom",
"properties": {
"identities": {
@@ -1084,18 +1104,18 @@
"type": "object"
},
"GoogleIdentityAccesscontextmanagerV1EgressTo": {
"description": "Defines the conditions under which an EgressPolicy matches a request. Conditions are based on information about the ApiOperation intended to be performed on the `resources` specified. Note that if the destination of the request is protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed.",
"description": "Defines the conditions under which an EgressPolicy matches a request. Conditions are based on information about the ApiOperation intended to be performed on the `resources` specified. Note that if the destination of the request is also protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed. The request must match `operations` AND `resources` fields in order to be allowed egress out of the perimeter.",
"id": "GoogleIdentityAccesscontextmanagerV1EgressTo",
"properties": {
"operations": {
"description": "A list of ApiOperations that this egress rule applies to. A request matches if it contains an operation/service in this list.",
"description": "A list of ApiOperations allowed to be performed by the sources specified in the corresponding EgressFrom. A request matches if it uses an operation/service in this list.",
"items": {
"$ref": "GoogleIdentityAccesscontextmanagerV1ApiOperation"
},
"type": "array"
},
"resources": {
"description": "A list of resources, currently only projects in the form `projects/`, that match this to stanza. A request matches if it contains a resource in this list. If `*` is specified for resources, then this EgressTo rule will authorize access to all resources outside the perimeter.",
"description": "A list of resources, currently only projects in the form `projects/`, that are allowed to be accessed by sources defined in the corresponding EgressFrom. A request matches if it contains a resource in this list. If `*` is specified for `resources`, then this EgressTo rule will authorize access to all resources outside the perimeter.",
"items": {
"type": "string"
},
@@ -1105,7 +1125,7 @@
"type": "object"
},
"GoogleIdentityAccesscontextmanagerV1IngressFrom": {
"description": "Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the source of the request.",
"description": "Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the source of the request. The request must satisfy what is defined in `sources` AND identity related fields in order to match.",
"id": "GoogleIdentityAccesscontextmanagerV1IngressFrom",
"properties": {
"identities": {
@@ -1161,7 +1181,7 @@
"id": "GoogleIdentityAccesscontextmanagerV1IngressSource",
"properties": {
"accessLevel": {
"description": "An AccessLevel resource name that allow resources within the ServicePerimeters to be accessed from the internet. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If no AccessLevel names are listed, resources within the perimeter can only be accessed via Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If `*` is specified, then all IngressSources will be allowed.",
"description": "An AccessLevel resource name that allow resources within the ServicePerimeters to be accessed from the internet. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If no AccessLevel names are listed, resources within the perimeter can only be accessed via Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all IngressSources will be allowed.",
"type": "string"
},
"resource": {
@@ -1172,18 +1192,18 @@
"type": "object"
},
"GoogleIdentityAccesscontextmanagerV1IngressTo": {
"description": "Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the ApiOperation intended to be performed on the destination of the request.",
"description": "Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the ApiOperation intended to be performed on the target resource of the request. The request must satisfy what is defined in `operations` AND `resources` in order to match.",
"id": "GoogleIdentityAccesscontextmanagerV1IngressTo",
"properties": {
"operations": {
"description": "A list of ApiOperations the sources specified in corresponding IngressFrom are allowed to perform in this ServicePerimeter.",
"description": "A list of ApiOperations allowed to be performed by the sources specified in corresponding IngressFrom in this ServicePerimeter.",
"items": {
"$ref": "GoogleIdentityAccesscontextmanagerV1ApiOperation"
},
"type": "array"
},
"resources": {
"description": "A list of resources, currently only projects in the form `projects/`, protected by this ServicePerimeter that are allowed to be accessed by sources defined in the corresponding IngressFrom. A request matches if it contains a resource in this list. If `*` is specified for resources, then this IngressTo rule will authorize access to all resources inside the perimeter, provided that the request also matches the `operations` field.",
"description": "A list of resources, currently only projects in the form `projects/`, protected by this ServicePerimeter that are allowed to be accessed by sources defined in the corresponding IngressFrom. If a single `*` is specified, then access to all resources inside the perimeter are allowed.",
"items": {
"type": "string"
},
@@ -1253,7 +1273,7 @@
"type": "string"
},
"name": {
"description": "Required. Resource name for the ServicePerimeter. The `short_name` component must begin with a letter and only include alphanumeric and '_'. Format: `accessPolicies/{policy_id}/servicePerimeters/{short_name}`",
"description": "Required. Resource name for the ServicePerimeter. The `short_name` component must begin with a letter and only include alphanumeric and '_'. Format: `accessPolicies/{access_policy}/servicePerimeters/{service_perimeter}`",
"type": "string"
},
"perimeterType": {
@@ -1515,7 +1535,7 @@
"type": "object"
},
"Policy": {
"description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).",
"description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).",
"id": "Policy",
"properties": {
"auditConfigs": {
@@ -1526,7 +1546,7 @@
"type": "array"
},
"bindings": {
"description": "Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.",
"description": "Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.",
"items": {
"$ref": "Binding"
},

64
etc/api/cloudasset/v1p5beta1/cloudasset-api.json
View File

@@ -3,7 +3,7 @@
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "View and manage your data across Google Cloud Platform services"
"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
}
}
}
@@ -136,7 +136,7 @@
"Resource metadata.",
"The actual IAM policy set on a resource.",
"The Cloud Organization Policy set on an asset.",
"The Cloud Access context mananger Policy set on an asset."
"The Cloud Access context manager Policy set on an asset."
],
"location": "query",
"type": "string"
@@ -153,7 +153,7 @@
"type": "string"
},
"parent": {
"description": "Required. Name of the organization or project the assets belong to. Format: \"organizations/[organization-number]\" (such as \"organizations/123\"), \"projects/[project-number]\" (such as \"projects/my-project-id\"), or \"projects/[project-id]\" (such as \"projects/12345\").",
"description": "Required. Name of the organization or project the assets belong to. Format: \"organizations/[organization-number]\" (such as \"organizations/123\"), \"projects/[project-id]\" (such as \"projects/my-project-id\"), or \"projects/[project-number]\" (such as \"projects/12345\").",
"location": "path",
"pattern": "^[^/]+/[^/]+$",
"required": true,
@@ -177,9 +177,22 @@
}
}
},
"revision": "20210319",
"revision": "20220225",
"rootUrl": "https://cloudasset.googleapis.com/",
"schemas": {
"AnalyzeIamPolicyLongrunningMetadata": {
"description": "Represents the metadata of the longrunning operation for the AnalyzeIamPolicyLongrunning rpc.",
"id": "AnalyzeIamPolicyLongrunningMetadata",
"properties": {
"createTime": {
"description": "Output only. The time the operation was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"AnalyzeIamPolicyLongrunningResponse": {
"description": "A response message for AssetService.AnalyzeIamPolicyLongrunning.",
"id": "AnalyzeIamPolicyLongrunningResponse",
@@ -284,22 +297,22 @@
"type": "object"
},
"Binding": {
"description": "Associates `members` with a `role`.",
"description": "Associates `members`, or principals, with a `role`.",
"id": "Binding",
"properties": {
"condition": {
"$ref": "Expr",
"description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)."
"description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)."
},
"members": {
"description": "Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ",
"description": "Specifies the principals requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ",
"items": {
"type": "string"
},
"type": "array"
},
"role": {
"description": "Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.",
"description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.",
"type": "string"
}
},
@@ -603,7 +616,7 @@
"type": "string"
},
"name": {
"description": "Required. Resource name for the Access Level. The `short_name` component must begin with a letter and only include alphanumeric and '_'. Format: `accessPolicies/{policy_id}/accessLevels/{short_name}`. The maximum length of the `short_name` component is 50 characters.",
"description": "Required. Resource name for the Access Level. The `short_name` component must begin with a letter and only include alphanumeric and '_'. Format: `accessPolicies/{access_policy}/accessLevels/{access_level}`. The maximum length of the `access_level` component is 50 characters.",
"type": "string"
},
"title": {
@@ -622,13 +635,20 @@
"type": "string"
},
"name": {
"description": "Output only. Resource name of the `AccessPolicy`. Format: `accessPolicies/{policy_id}`",
"description": "Output only. Resource name of the `AccessPolicy`. Format: `accessPolicies/{access_policy}`",
"type": "string"
},
"parent": {
"description": "Required. The parent of this `AccessPolicy` in the Cloud Resource Hierarchy. Currently immutable once created. Format: `organizations/{organization_id}`",
"type": "string"
},
"scopes": {
"description": "The scopes of a policy define which resources an ACM policy can restrict, and where ACM resources can be referenced. For example, a policy with scopes=[\"folders/123\"] has the following behavior: - vpcsc perimeters can only restrict projects within folders/123 - access levels can only be referenced by resources within folders/123. If empty, there are no limitations on which resources can be restricted by an ACM policy, and there are no limitations on where ACM resources can be referenced. Only one policy can include a given scope (attempting to create a second policy which includes \"folders/123\" will result in an error). Currently, scopes cannot be modified after a policy is created. Currently, policies can only have a single scope. Format: list of `folders/{folder_number}` or `projects/{project_number}`",
"items": {
"type": "string"
},
"type": "array"
},
"title": {
"description": "Required. Human readable title. Does not affect behavior.",
"type": "string"
@@ -799,7 +819,7 @@
"type": "object"
},
"GoogleIdentityAccesscontextmanagerV1EgressFrom": {
"description": "Defines the conditions under which an EgressPolicy matches a request. Conditions based on information about the source of the request. Note that if the destination of the request is protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed.",
"description": "Defines the conditions under which an EgressPolicy matches a request. Conditions based on information about the source of the request. Note that if the destination of the request is also protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed.",
"id": "GoogleIdentityAccesscontextmanagerV1EgressFrom",
"properties": {
"identities": {
@@ -844,18 +864,18 @@
"type": "object"
},
"GoogleIdentityAccesscontextmanagerV1EgressTo": {
"description": "Defines the conditions under which an EgressPolicy matches a request. Conditions are based on information about the ApiOperation intended to be performed on the `resources` specified. Note that if the destination of the request is protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed.",
"description": "Defines the conditions under which an EgressPolicy matches a request. Conditions are based on information about the ApiOperation intended to be performed on the `resources` specified. Note that if the destination of the request is also protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed. The request must match `operations` AND `resources` fields in order to be allowed egress out of the perimeter.",
"id": "GoogleIdentityAccesscontextmanagerV1EgressTo",
"properties": {
"operations": {
"description": "A list of ApiOperations that this egress rule applies to. A request matches if it contains an operation/service in this list.",
"description": "A list of ApiOperations allowed to be performed by the sources specified in the corresponding EgressFrom. A request matches if it uses an operation/service in this list.",
"items": {
"$ref": "GoogleIdentityAccesscontextmanagerV1ApiOperation"
},
"type": "array"
},
"resources": {
"description": "A list of resources, currently only projects in the form `projects/`, that match this to stanza. A request matches if it contains a resource in this list. If `*` is specified for resources, then this EgressTo rule will authorize access to all resources outside the perimeter.",
"description": "A list of resources, currently only projects in the form `projects/`, that are allowed to be accessed by sources defined in the corresponding EgressFrom. A request matches if it contains a resource in this list. If `*` is specified for `resources`, then this EgressTo rule will authorize access to all resources outside the perimeter.",
"items": {
"type": "string"
},
@@ -865,7 +885,7 @@
"type": "object"
},
"GoogleIdentityAccesscontextmanagerV1IngressFrom": {
"description": "Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the source of the request.",
"description": "Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the source of the request. The request must satisfy what is defined in `sources` AND identity related fields in order to match.",
"id": "GoogleIdentityAccesscontextmanagerV1IngressFrom",
"properties": {
"identities": {
@@ -921,7 +941,7 @@
"id": "GoogleIdentityAccesscontextmanagerV1IngressSource",
"properties": {
"accessLevel": {
"description": "An AccessLevel resource name that allow resources within the ServicePerimeters to be accessed from the internet. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If no AccessLevel names are listed, resources within the perimeter can only be accessed via Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If `*` is specified, then all IngressSources will be allowed.",
"description": "An AccessLevel resource name that allow resources within the ServicePerimeters to be accessed from the internet. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If no AccessLevel names are listed, resources within the perimeter can only be accessed via Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all IngressSources will be allowed.",
"type": "string"
},
"resource": {
@@ -932,18 +952,18 @@
"type": "object"
},
"GoogleIdentityAccesscontextmanagerV1IngressTo": {
"description": "Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the ApiOperation intended to be performed on the destination of the request.",
"description": "Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the ApiOperation intended to be performed on the target resource of the request. The request must satisfy what is defined in `operations` AND `resources` in order to match.",
"id": "GoogleIdentityAccesscontextmanagerV1IngressTo",
"properties": {
"operations": {
"description": "A list of ApiOperations the sources specified in corresponding IngressFrom are allowed to perform in this ServicePerimeter.",
"description": "A list of ApiOperations allowed to be performed by the sources specified in corresponding IngressFrom in this ServicePerimeter.",
"items": {
"$ref": "GoogleIdentityAccesscontextmanagerV1ApiOperation"
},
"type": "array"
},
"resources": {
"description": "A list of resources, currently only projects in the form `projects/`, protected by this ServicePerimeter that are allowed to be accessed by sources defined in the corresponding IngressFrom. A request matches if it contains a resource in this list. If `*` is specified for resources, then this IngressTo rule will authorize access to all resources inside the perimeter, provided that the request also matches the `operations` field.",
"description": "A list of resources, currently only projects in the form `projects/`, protected by this ServicePerimeter that are allowed to be accessed by sources defined in the corresponding IngressFrom. If a single `*` is specified, then access to all resources inside the perimeter are allowed.",
"items": {
"type": "string"
},
@@ -1013,7 +1033,7 @@
"type": "string"
},
"name": {
"description": "Required. Resource name for the ServicePerimeter. The `short_name` component must begin with a letter and only include alphanumeric and '_'. Format: `accessPolicies/{policy_id}/servicePerimeters/{short_name}`",
"description": "Required. Resource name for the ServicePerimeter. The `short_name` component must begin with a letter and only include alphanumeric and '_'. Format: `accessPolicies/{access_policy}/servicePerimeters/{service_perimeter}`",
"type": "string"
},
"perimeterType": {
@@ -1135,7 +1155,7 @@
"type": "object"
},
"Policy": {
"description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).",
"description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).",
"id": "Policy",
"properties": {
"auditConfigs": {
@@ -1146,7 +1166,7 @@
"type": "array"
},
"bindings": {
"description": "Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.",
"description": "Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.",
"items": {
"$ref": "Binding"
},

60
etc/api/cloudasset/v1p7beta1/cloudasset-api.json
View File

@@ -3,7 +3,7 @@
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "View and manage your data across Google Cloud Platform services"
"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
}
}
}
@@ -167,9 +167,22 @@
}
}
},
"revision": "20210319",
"revision": "20220225",
"rootUrl": "https://cloudasset.googleapis.com/",
"schemas": {
"AnalyzeIamPolicyLongrunningMetadata": {
"description": "Represents the metadata of the longrunning operation for the AnalyzeIamPolicyLongrunning rpc.",
"id": "AnalyzeIamPolicyLongrunningMetadata",
"properties": {
"createTime": {
"description": "Output only. The time the operation was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"AnalyzeIamPolicyLongrunningResponse": {
"description": "A response message for AssetService.AnalyzeIamPolicyLongrunning.",
"id": "AnalyzeIamPolicyLongrunningResponse",
@@ -225,22 +238,22 @@
"type": "object"
},
"Binding": {
"description": "Associates `members` with a `role`.",
"description": "Associates `members`, or principals, with a `role`.",
"id": "Binding",
"properties": {
"condition": {
"$ref": "Expr",
"description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)."
"description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)."
},
"members": {
"description": "Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ",
"description": "Specifies the principals requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ",
"items": {
"type": "string"
},
"type": "array"
},
"role": {
"description": "Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.",
"description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.",
"type": "string"
}
},
@@ -672,7 +685,7 @@
"type": "string"
},
"name": {
"description": "Required. Resource name for the Access Level. The `short_name` component must begin with a letter and only include alphanumeric and '_'. Format: `accessPolicies/{policy_id}/accessLevels/{short_name}`. The maximum length of the `short_name` component is 50 characters.",
"description": "Required. Resource name for the Access Level. The `short_name` component must begin with a letter and only include alphanumeric and '_'. Format: `accessPolicies/{access_policy}/accessLevels/{access_level}`. The maximum length of the `access_level` component is 50 characters.",
"type": "string"
},
"title": {
@@ -691,13 +704,20 @@
"type": "string"
},
"name": {
"description": "Output only. Resource name of the `AccessPolicy`. Format: `accessPolicies/{policy_id}`",
"description": "Output only. Resource name of the `AccessPolicy`. Format: `accessPolicies/{access_policy}`",
"type": "string"
},
"parent": {
"description": "Required. The parent of this `AccessPolicy` in the Cloud Resource Hierarchy. Currently immutable once created. Format: `organizations/{organization_id}`",
"type": "string"
},
"scopes": {
"description": "The scopes of a policy define which resources an ACM policy can restrict, and where ACM resources can be referenced. For example, a policy with scopes=[\"folders/123\"] has the following behavior: - vpcsc perimeters can only restrict projects within folders/123 - access levels can only be referenced by resources within folders/123. If empty, there are no limitations on which resources can be restricted by an ACM policy, and there are no limitations on where ACM resources can be referenced. Only one policy can include a given scope (attempting to create a second policy which includes \"folders/123\" will result in an error). Currently, scopes cannot be modified after a policy is created. Currently, policies can only have a single scope. Format: list of `folders/{folder_number}` or `projects/{project_number}`",
"items": {
"type": "string"
},
"type": "array"
},
"title": {
"description": "Required. Human readable title. Does not affect behavior.",
"type": "string"
@@ -868,7 +888,7 @@
"type": "object"
},
"GoogleIdentityAccesscontextmanagerV1EgressFrom": {
"description": "Defines the conditions under which an EgressPolicy matches a request. Conditions based on information about the source of the request. Note that if the destination of the request is protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed.",
"description": "Defines the conditions under which an EgressPolicy matches a request. Conditions based on information about the source of the request. Note that if the destination of the request is also protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed.",
"id": "GoogleIdentityAccesscontextmanagerV1EgressFrom",
"properties": {
"identities": {
@@ -913,18 +933,18 @@
"type": "object"
},
"GoogleIdentityAccesscontextmanagerV1EgressTo": {
"description": "Defines the conditions under which an EgressPolicy matches a request. Conditions are based on information about the ApiOperation intended to be performed on the `resources` specified. Note that if the destination of the request is protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed.",
"description": "Defines the conditions under which an EgressPolicy matches a request. Conditions are based on information about the ApiOperation intended to be performed on the `resources` specified. Note that if the destination of the request is also protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed. The request must match `operations` AND `resources` fields in order to be allowed egress out of the perimeter.",
"id": "GoogleIdentityAccesscontextmanagerV1EgressTo",
"properties": {
"operations": {
"description": "A list of ApiOperations that this egress rule applies to. A request matches if it contains an operation/service in this list.",
"description": "A list of ApiOperations allowed to be performed by the sources specified in the corresponding EgressFrom. A request matches if it uses an operation/service in this list.",
"items": {
"$ref": "GoogleIdentityAccesscontextmanagerV1ApiOperation"
},
"type": "array"
},
"resources": {
"description": "A list of resources, currently only projects in the form `projects/`, that match this to stanza. A request matches if it contains a resource in this list. If `*` is specified for resources, then this EgressTo rule will authorize access to all resources outside the perimeter.",
"description": "A list of resources, currently only projects in the form `projects/`, that are allowed to be accessed by sources defined in the corresponding EgressFrom. A request matches if it contains a resource in this list. If `*` is specified for `resources`, then this EgressTo rule will authorize access to all resources outside the perimeter.",
"items": {
"type": "string"
},
@@ -934,7 +954,7 @@
"type": "object"
},
"GoogleIdentityAccesscontextmanagerV1IngressFrom": {
"description": "Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the source of the request.",
"description": "Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the source of the request. The request must satisfy what is defined in `sources` AND identity related fields in order to match.",
"id": "GoogleIdentityAccesscontextmanagerV1IngressFrom",
"properties": {
"identities": {
@@ -990,7 +1010,7 @@
"id": "GoogleIdentityAccesscontextmanagerV1IngressSource",
"properties": {
"accessLevel": {
"description": "An AccessLevel resource name that allow resources within the ServicePerimeters to be accessed from the internet. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If no AccessLevel names are listed, resources within the perimeter can only be accessed via Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If `*` is specified, then all IngressSources will be allowed.",
"description": "An AccessLevel resource name that allow resources within the ServicePerimeters to be accessed from the internet. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If no AccessLevel names are listed, resources within the perimeter can only be accessed via Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all IngressSources will be allowed.",
"type": "string"
},
"resource": {
@@ -1001,18 +1021,18 @@
"type": "object"
},
"GoogleIdentityAccesscontextmanagerV1IngressTo": {
"description": "Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the ApiOperation intended to be performed on the destination of the request.",
"description": "Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the ApiOperation intended to be performed on the target resource of the request. The request must satisfy what is defined in `operations` AND `resources` in order to match.",
"id": "GoogleIdentityAccesscontextmanagerV1IngressTo",
"properties": {
"operations": {
"description": "A list of ApiOperations the sources specified in corresponding IngressFrom are allowed to perform in this ServicePerimeter.",
"description": "A list of ApiOperations allowed to be performed by the sources specified in corresponding IngressFrom in this ServicePerimeter.",
"items": {
"$ref": "GoogleIdentityAccesscontextmanagerV1ApiOperation"
},
"type": "array"
},
"resources": {
"description": "A list of resources, currently only projects in the form `projects/`, protected by this ServicePerimeter that are allowed to be accessed by sources defined in the corresponding IngressFrom. A request matches if it contains a resource in this list. If `*` is specified for resources, then this IngressTo rule will authorize access to all resources inside the perimeter, provided that the request also matches the `operations` field.",
"description": "A list of resources, currently only projects in the form `projects/`, protected by this ServicePerimeter that are allowed to be accessed by sources defined in the corresponding IngressFrom. If a single `*` is specified, then access to all resources inside the perimeter are allowed.",
"items": {
"type": "string"
},
@@ -1082,7 +1102,7 @@
"type": "string"
},
"name": {
"description": "Required. Resource name for the ServicePerimeter. The `short_name` component must begin with a letter and only include alphanumeric and '_'. Format: `accessPolicies/{policy_id}/servicePerimeters/{short_name}`",
"description": "Required. Resource name for the ServicePerimeter. The `short_name` component must begin with a letter and only include alphanumeric and '_'. Format: `accessPolicies/{access_policy}/servicePerimeters/{service_perimeter}`",
"type": "string"
},
"perimeterType": {
@@ -1216,7 +1236,7 @@
"type": "object"
},
"Policy": {
"description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).",
"description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).",
"id": "Policy",
"properties": {
"auditConfigs": {
@@ -1227,7 +1247,7 @@
"type": "array"
},
"bindings": {
"description": "Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.",
"description": "Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.",
"items": {
"$ref": "Binding"
},

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

@@ -9,7 +9,7 @@
"description": "View your Google Cloud Platform billing accounts"
},
"https://www.googleapis.com/auth/cloud-platform": {
"description": "See, edit, configure, and delete your Google Cloud Platform data"
"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
}
}
}
@@ -169,7 +169,7 @@
],
"parameters": {
"options.requestedPolicyVersion": {
"description": "Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
"format": "int32",
"location": "query",
"type": "integer"
@@ -369,7 +369,7 @@
"projects": {
"methods": {
"getBillingInfo": {
"description": "Gets the billing information for a project. The current authenticated user must have [permission to view the project](https://cloud.google.com/docs/permissions-overview#h.bgs0oxofvnoo ).",
"description": "Gets the billing information for a project. The current authenticated user must have the `resourcemanager.projects.get` permission for the project, which can be granted by assigning the [Project Viewer](https://cloud.google.com/iam/docs/understanding-roles#predefined_roles) role.",
"flatPath": "v1/projects/{projectsId}/billingInfo",
"httpMethod": "GET",
"id": "cloudbilling.projects.getBillingInfo",
@@ -521,7 +521,7 @@
}
}
},
"revision": "20210322",
"revision": "20220305",
"rootUrl": "https://cloudbilling.googleapis.com/",
"schemas": {
"AggregationInfo": {
@@ -636,22 +636,22 @@
"type": "object"
},
"Binding": {
"description": "Associates `members` with a `role`.",
"description": "Associates `members`, or principals, with a `role`.",
"id": "Binding",
"properties": {
"condition": {
"$ref": "Expr",
"description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)."
"description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)."
},
"members": {
"description": "Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ",
"description": "Specifies the principals requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ",
"items": {
"type": "string"
},
"type": "array"
},
"role": {
"description": "Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.",
"description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.",
"type": "string"
}
},
@@ -827,7 +827,7 @@
"type": "object"
},
"Policy": {
"description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).",
"description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).",
"id": "Policy",
"properties": {
"auditConfigs": {
@@ -838,7 +838,7 @@
"type": "array"
},
"bindings": {
"description": "Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.",
"description": "Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.",
"items": {
"$ref": "Binding"
},

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

File diff suppressed because it is too large Load Diff

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

@@ -3,7 +3,7 @@
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "See, edit, configure, and delete your Google Cloud Platform data"
"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
}
}
}
@@ -306,9 +306,60 @@
}
}
},
"revision": "20210329",
"revision": "20220218",
"rootUrl": "https://cloudbuild.googleapis.com/",
"schemas": {
"ApprovalConfig": {
"description": "ApprovalConfig describes configuration for manual approval of a build.",
"id": "ApprovalConfig",
"properties": {
"approvalRequired": {
"description": "Whether or not approval is needed. If this is set on a build, it will become pending when created, and will need to be explicitly approved to start.",
"type": "boolean"
}
},
"type": "object"
},
"ApprovalResult": {
"description": "ApprovalResult describes the decision and associated metadata of a manual approval of a build.",
"id": "ApprovalResult",
"properties": {
"approvalTime": {
"description": "Output only. The time when the approval decision was made.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"approverAccount": {
"description": "Output only. Email of the user that called the ApproveBuild API to approve or reject a build at the time that the API was called.",
"readOnly": true,
"type": "string"
},
"comment": {
"description": "Optional. An optional comment for this manual approval result.",
"type": "string"
},
"decision": {
"description": "Required. The decision of this manual approval.",
"enum": [
"DECISION_UNSPECIFIED",
"APPROVED",
"REJECTED"
],
"enumDescriptions": [
"Default enum type. This should not be used.",
"Build is approved.",
"Build is rejected."
],
"type": "string"
},
"url": {
"description": "Optional. An optional URL tied to this manual approval result. This field is essentially the same as comment, except that it will be rendered by the UI differently. An example use case is a link to an external job that approved this Build.",
"type": "string"
}
},
"type": "object"
},
"ArtifactObjects": {
"description": "Files in the workspace to upload to Cloud Storage upon successful completion of all build steps.",
"id": "ArtifactObjects",
@@ -368,10 +419,91 @@
},
"type": "object"
},
"BatchCreateBitbucketServerConnectedRepositoriesResponse": {
"description": "Response of BatchCreateBitbucketServerConnectedRepositories RPC method including all successfully connected Bitbucket Server repositories.",
"id": "BatchCreateBitbucketServerConnectedRepositoriesResponse",
"properties": {
"bitbucketServerConnectedRepositories": {
"description": "The connected Bitbucket Server repositories.",
"items": {
"$ref": "BitbucketServerConnectedRepository"
},
"type": "array"
}
},
"type": "object"
},
"BatchCreateBitbucketServerConnectedRepositoriesResponseMetadata": {
"description": "Metadata for `BatchCreateBitbucketServerConnectedRepositories` operation.",
"id": "BatchCreateBitbucketServerConnectedRepositoriesResponseMetadata",
"properties": {
"completeTime": {
"description": "Time the operation was completed.",
"format": "google-datetime",
"type": "string"
},
"config": {
"description": "The name of the `BitbucketServerConfig` that added connected repositories. Format: `projects/{project}/locations/{location}/bitbucketServerConfigs/{config}`",
"type": "string"
},
"createTime": {
"description": "Time the operation was created.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"BitbucketServerConnectedRepository": {
"description": "/ BitbucketServerConnectedRepository represents a connected Bitbucket Server / repository.",
"id": "BitbucketServerConnectedRepository",
"properties": {
"parent": {
"description": "The name of the `BitbucketServerConfig` that added connected repository. Format: `projects/{project}/locations/{location}/bitbucketServerConfigs/{config}`",
"type": "string"
},
"repo": {
"$ref": "BitbucketServerRepositoryId",
"description": "The Bitbucket Server repositories to connect."
},
"status": {
"$ref": "Status",
"description": "Output only. The status of the repo connection request.",
"readOnly": true
}
},
"type": "object"
},
"BitbucketServerRepositoryId": {
"description": "BitbucketServerRepositoryId identifies a specific repository hosted on a Bitbucket Server.",
"id": "BitbucketServerRepositoryId",
"properties": {
"projectKey": {
"description": "Required. Identifier for the project storing the repository.",
"type": "string"
},
"repoSlug": {
"description": "Required. Identifier for the repository.",
"type": "string"
},
"webhookId": {
"description": "Output only. The ID of the webhook that was created for receiving events from this repo. We only create and manage a single webhook for each repo.",
"format": "int32",
"readOnly": true,
"type": "integer"
}
},
"type": "object"
},
"Build": {
"description": "A build resource in the Cloud Build API. At a high level, a `Build` describes where to find source code, how to build it (for example, the builder image to run on the source), and where to store the built artifacts. Fields can include the following variables, which will be expanded when the build is created: - $PROJECT_ID: the project ID of the build. - $PROJECT_NUMBER: the project number of the build. - $BUILD_ID: the autogenerated ID of the build. - $REPO_NAME: the source repository name specified by RepoSource. - $BRANCH_NAME: the branch name specified by RepoSource. - $TAG_NAME: the tag name specified by RepoSource. - $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or resolved from the specified branch or tag. - $SHORT_SHA: first 7 characters of $REVISION_ID or $COMMIT_SHA.",
"description": "A build resource in the Cloud Build API. At a high level, a `Build` describes where to find source code, how to build it (for example, the builder image to run on the source), and where to store the built artifacts. Fields can include the following variables, which will be expanded when the build is created: - $PROJECT_ID: the project ID of the build. - $PROJECT_NUMBER: the project number of the build. - $LOCATION: the location/region of the build. - $BUILD_ID: the autogenerated ID of the build. - $REPO_NAME: the source repository name specified by RepoSource. - $BRANCH_NAME: the branch name specified by RepoSource. - $TAG_NAME: the tag name specified by RepoSource. - $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or resolved from the specified branch or tag. - $SHORT_SHA: first 7 characters of $REVISION_ID or $COMMIT_SHA.",
"id": "Build",
"properties": {
"approval": {
"$ref": "BuildApproval",
"description": "Output only. Describes this build's approval configuration, status, and result.",
"readOnly": true
},
"artifacts": {
"$ref": "Artifacts",
"description": "Artifacts produced by the build that should be uploaded upon successful completion of all build steps."
@@ -391,6 +523,11 @@
"readOnly": true,
"type": "string"
},
"failureInfo": {
"$ref": "FailureInfo",
"description": "Output only. Contains information about the build when status=FAILURE.",
"readOnly": true
},
"finishTime": {
"description": "Output only. Time at which execution of the build was finished. The difference between finish_time and start_time is the duration of the build's execution.",
"format": "google-datetime",
@@ -450,7 +587,7 @@
"type": "array"
},
"serviceAccount": {
"description": "IAM service account whose credentials will be used at build runtime. Must be of the format `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. ACCOUNT can be email address or uniqueId of the service account. This field is in beta.",
"description": "IAM service account whose credentials will be used at build runtime. Must be of the format `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. ACCOUNT can be email address or uniqueId of the service account. ",
"type": "string"
},
"source": {
@@ -472,6 +609,7 @@
"description": "Output only. Status of the build.",
"enum": [
"STATUS_UNKNOWN",
"PENDING",
"QUEUED",
"WORKING",
"SUCCESS",
@@ -483,6 +621,7 @@
],
"enumDescriptions": [
"Status of the build is unknown.",
"Build has been created and is pending execution and queuing. It has not been queued.",
"Build or step is queued; work has not yet begun.",
"Build or step is being executed.",
"Build or step finished successfully.",
@@ -530,9 +669,53 @@
"additionalProperties": {
"$ref": "TimeSpan"
},
"description": "Output only. Stores timing information for phases of the build. Valid keys are: * BUILD: time to execute all build steps * PUSH: time to push all specified images. * FETCHSOURCE: time to fetch source. If the build does not specify source or images, these keys will not be included.",
"description": "Output only. Stores timing information for phases of the build. Valid keys are: * BUILD: time to execute all build steps. * PUSH: time to push all specified images. * FETCHSOURCE: time to fetch source. * SETUPBUILD: time to set up build. If the build does not specify source or images, these keys will not be included.",
"readOnly": true,
"type": "object"
},
"warnings": {
"description": "Output only. Non-fatal problems encountered during the execution of the build.",
"items": {
"$ref": "Warning"
},
"readOnly": true,
"type": "array"
}
},
"type": "object"
},
"BuildApproval": {
"description": "BuildApproval describes a build's approval configuration, state, and result.",
"id": "BuildApproval",
"properties": {
"config": {
"$ref": "ApprovalConfig",
"description": "Output only. Configuration for manual approval of this build.",
"readOnly": true
},
"result": {
"$ref": "ApprovalResult",
"description": "Output only. Result of manual approval for this Build.",
"readOnly": true
},
"state": {
"description": "Output only. The state of this build's approval.",
"enum": [
"STATE_UNSPECIFIED",
"PENDING",
"APPROVED",
"REJECTED",
"CANCELLED"
],
"enumDescriptions": [
"Default enum type. This should not be used.",
"Build approval is pending.",
"Build approval has been approved.",
"Build approval has been rejected.",
"Build was cancelled while it was still pending approval."
],
"readOnly": true,
"type": "string"
}
},
"type": "object"
@@ -594,10 +777,10 @@
],
"enumDescriptions": [
"The service determines the logging mode. The default is `LEGACY`. Do not rely on the default logging behavior as it may change in the future.",
"Cloud Logging and Cloud Storage logging are enabled.",
"Only Cloud Storage logging is enabled.",
"Build logs are stored in Cloud Logging and Cloud Storage.",
"Build logs are stored in Cloud Storage.",
"This option is the same as CLOUD_LOGGING_ONLY.",
"Only Cloud Logging is enabled. Note that logs for both the Cloud Console UI and Cloud SDK are based on Cloud Storage logs, so neither will provide logs if this option is chosen.",
"Build logs are stored in Cloud Logging. Selecting this option will not allow [logs streaming](https://cloud.google.com/sdk/gcloud/reference/builds/log).",
"Turn off all logging. No build logs will be captured."
],
"type": "string"
@@ -620,6 +803,10 @@
],
"type": "string"
},
"pool": {
"$ref": "PoolOption",
"description": "Optional. Specification for execution on a `WorkerPool`. See [running builds in a private pool](https://cloud.google.com/build/docs/private-pools/run-builds-in-private-pool) for more information."
},
"requestedVerifyOption": {
"description": "Requested verifiability options.",
"enum": [
@@ -676,7 +863,7 @@
"type": "array"
},
"workerPool": {
"description": "Option to specify a `WorkerPool` for the build. Format: projects/{project}/locations/{location}/workerPools/{workerPool} This field is in beta and is available only to restricted users.",
"description": "This field deprecated; please use `pool.name` instead.",
"type": "string"
}
},
@@ -721,6 +908,10 @@
"description": "Output only. Stores timing information for pulling this build step's builder image only.",
"readOnly": true
},
"script": {
"description": "A shell script to be executed in the step. When script is provided, the user cannot specify the entrypoint or args.",
"type": "string"
},
"secretEnv": {
"description": "A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's `Secret`.",
"items": {
@@ -732,6 +923,7 @@
"description": "Output only. Status of the build step. At this time, build step status is only updated on build completion; step status is not updated in real-time as the build progresses.",
"enum": [
"STATUS_UNKNOWN",
"PENDING",
"QUEUED",
"WORKING",
"SUCCESS",
@@ -743,6 +935,7 @@
],
"enumDescriptions": [
"Status of the build is unknown.",
"Build has been created and is pending execution and queuing. It has not been queued.",
"Build or step is queued; work has not yet begun.",
"Build or step is being executed.",
"Build or step finished successfully.",
@@ -808,12 +1001,213 @@
"properties": {},
"type": "object"
},
"CreateBitbucketServerConfigOperationMetadata": {
"description": "Metadata for `CreateBitbucketServerConfig` operation.",
"id": "CreateBitbucketServerConfigOperationMetadata",
"properties": {
"bitbucketServerConfig": {
"description": "The resource name of the BitbucketServerConfig to be created. Format: `projects/{project}/locations/{location}/bitbucketServerConfigs/{id}`.",
"type": "string"
},
"completeTime": {
"description": "Time the operation was completed.",
"format": "google-datetime",
"type": "string"
},
"createTime": {
"description": "Time the operation was created.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"CreateGitHubEnterpriseConfigOperationMetadata": {
"description": "Metadata for `CreateGithubEnterpriseConfig` operation.",
"id": "CreateGitHubEnterpriseConfigOperationMetadata",
"properties": {
"completeTime": {
"description": "Time the operation was completed.",
"format": "google-datetime",
"type": "string"
},
"createTime": {
"description": "Time the operation was created.",
"format": "google-datetime",
"type": "string"
},
"githubEnterpriseConfig": {
"description": "The resource name of the GitHubEnterprise to be created. Format: `projects/{project}/locations/{location}/githubEnterpriseConfigs/{id}`.",
"type": "string"
}
},
"type": "object"
},
"CreateGitLabConfigOperationMetadata": {
"description": "Metadata for `CreateGitLabConfig` operation.",
"id": "CreateGitLabConfigOperationMetadata",
"properties": {
"completeTime": {
"description": "Time the operation was completed.",
"format": "google-datetime",
"type": "string"
},
"createTime": {
"description": "Time the operation was created.",
"format": "google-datetime",
"type": "string"
},
"gitlabConfig": {
"description": "The resource name of the GitLabConfig to be created. Format: `projects/{project}/locations/{location}/gitlabConfigs/{id}`.",
"type": "string"
}
},
"type": "object"
},
"CreateWorkerPoolOperationMetadata": {
"description": "Metadata for the `CreateWorkerPool` operation.",
"id": "CreateWorkerPoolOperationMetadata",
"properties": {
"completeTime": {
"description": "Time the operation was completed.",
"format": "google-datetime",
"type": "string"
},
"createTime": {
"description": "Time the operation was created.",
"format": "google-datetime",
"type": "string"
},
"workerPool": {
"description": "The resource name of the `WorkerPool` to create. Format: `projects/{project}/locations/{location}/workerPools/{worker_pool}`.",
"type": "string"
}
},
"type": "object"
},
"DeleteBitbucketServerConfigOperationMetadata": {
"description": "Metadata for `DeleteBitbucketServerConfig` operation.",
"id": "DeleteBitbucketServerConfigOperationMetadata",
"properties": {
"bitbucketServerConfig": {
"description": "The resource name of the BitbucketServerConfig to be deleted. Format: `projects/{project}/locations/{location}/bitbucketServerConfigs/{id}`.",
"type": "string"
},
"completeTime": {
"description": "Time the operation was completed.",
"format": "google-datetime",
"type": "string"
},
"createTime": {
"description": "Time the operation was created.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"DeleteGitHubEnterpriseConfigOperationMetadata": {
"description": "Metadata for `DeleteGitHubEnterpriseConfig` operation.",
"id": "DeleteGitHubEnterpriseConfigOperationMetadata",
"properties": {
"completeTime": {
"description": "Time the operation was completed.",
"format": "google-datetime",
"type": "string"
},
"createTime": {
"description": "Time the operation was created.",
"format": "google-datetime",
"type": "string"
},
"githubEnterpriseConfig": {
"description": "The resource name of the GitHubEnterprise to be deleted. Format: `projects/{project}/locations/{location}/githubEnterpriseConfigs/{id}`.",
"type": "string"
}
},
"type": "object"
},
"DeleteGitLabConfigOperationMetadata": {
"description": "Metadata for `DeleteGitLabConfig` operation.",
"id": "DeleteGitLabConfigOperationMetadata",
"properties": {
"completeTime": {
"description": "Time the operation was completed.",
"format": "google-datetime",
"type": "string"
},
"createTime": {
"description": "Time the operation was created.",
"format": "google-datetime",
"type": "string"
},
"gitlabConfig": {
"description": "The resource name of the GitLabConfig to be created. Format: `projects/{project}/locations/{location}/gitlabConfigs/{id}`.",
"type": "string"
}
},
"type": "object"
},
"DeleteWorkerPoolOperationMetadata": {
"description": "Metadata for the `DeleteWorkerPool` operation.",
"id": "DeleteWorkerPoolOperationMetadata",
"properties": {
"completeTime": {
"description": "Time the operation was completed.",
"format": "google-datetime",
"type": "string"
},
"createTime": {
"description": "Time the operation was created.",
"format": "google-datetime",
"type": "string"
},
"workerPool": {
"description": "The resource name of the `WorkerPool` being deleted. Format: `projects/{project}/locations/{location}/workerPools/{worker_pool}`.",
"type": "string"
}
},
"type": "object"
},
"Empty": {
"description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.",
"id": "Empty",
"properties": {},
"type": "object"
},
"FailureInfo": {
"description": "A fatal problem encountered during the execution of the build.",
"id": "FailureInfo",
"properties": {
"detail": {
"description": "Explains the failure issue in more detail using hard-coded text.",
"type": "string"
},
"type": {
"description": "The name of the failure.",
"enum": [
"FAILURE_TYPE_UNSPECIFIED",
"PUSH_FAILED",
"PUSH_IMAGE_NOT_FOUND",
"PUSH_NOT_AUTHORIZED",
"LOGGING_FAILURE",
"USER_BUILD_STEP",
"FETCH_SOURCE_FAILED"
],
"enumDescriptions": [
"Type unspecified",
"Unable to push the image to the repository.",
"Final image not found.",
"Unauthorized push of the final image.",
"Backend logging failures. Should retry.",
"A build step has failed.",
"The source fetching has failed."
],
"type": "string"
}
},
"type": "object"
},
"FileHashes": {
"description": "Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build.",
"id": "FileHashes",
@@ -828,6 +1222,50 @@
},
"type": "object"
},
"GoogleDevtoolsCloudbuildV2OperationMetadata": {
"description": "Represents the metadata of the long-running operation.",
"id": "GoogleDevtoolsCloudbuildV2OperationMetadata",
"properties": {
"apiVersion": {
"description": "Output only. API version used to start the operation.",
"readOnly": true,
"type": "string"
},
"createTime": {
"description": "Output only. The time the operation was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"endTime": {
"description": "Output only. The time the operation finished running.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"requestedCancellation": {
"description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.",
"readOnly": true,
"type": "boolean"
},
"statusMessage": {
"description": "Output only. Human-readable status of the operation, if any.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Output only. Server-defined resource path for the target of the operation.",
"readOnly": true,
"type": "string"
},
"verb": {
"description": "Output only. Name of the verb executed by the operation.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"HTTPDelivery": {
"description": "HTTPDelivery is the delivery configuration for an HTTP notification.",
"id": "HTTPDelivery",
@@ -1065,6 +1503,82 @@
},
"type": "object"
},
"OperationMetadata": {
"description": "Represents the metadata of the long-running operation.",
"id": "OperationMetadata",
"properties": {
"apiVersion": {
"description": "Output only. API version used to start the operation.",
"readOnly": true,
"type": "string"
},
"cancelRequested": {
"description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.",
"readOnly": true,
"type": "boolean"
},
"createTime": {
"description": "Output only. The time the operation was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"endTime": {
"description": "Output only. The time the operation finished running.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"statusDetail": {
"description": "Output only. Human-readable status of the operation, if any.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Output only. Server-defined resource path for the target of the operation.",
"readOnly": true,
"type": "string"
},
"verb": {
"description": "Output only. Name of the verb executed by the operation.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"PoolOption": {
"description": "Details about how a build should be executed on a `WorkerPool`. See [running builds in a private pool](https://cloud.google.com/build/docs/private-pools/run-builds-in-private-pool) for more information.",
"id": "PoolOption",
"properties": {
"name": {
"description": "The `WorkerPool` resource to execute the build on. You must have `cloudbuild.workerpools.use` on the project hosting the WorkerPool. Format projects/{project}/locations/{location}/workerPools/{workerPoolId}",
"type": "string"
}
},
"type": "object"
},
"ProcessAppManifestCallbackOperationMetadata": {
"description": "Metadata for `ProcessAppManifestCallback` operation.",
"id": "ProcessAppManifestCallbackOperationMetadata",
"properties": {
"completeTime": {
"description": "Time the operation was completed.",
"format": "google-datetime",
"type": "string"
},
"createTime": {
"description": "Time the operation was created.",
"format": "google-datetime",
"type": "string"
},
"githubEnterpriseConfig": {
"description": "The resource name of the GitHubEnterprise to be created. Format: `projects/{project}/locations/{location}/githubEnterpriseConfigs/{id}`.",
"type": "string"
}
},
"type": "object"
},
"RepoSource": {
"description": "Location of the source in a Google Cloud Source Repository.",
"id": "RepoSource",
@@ -1149,6 +1663,50 @@
},
"type": "object"
},
"RunWorkflowCustomOperationMetadata": {
"description": "Represents the custom metadata of the RunWorkflow long-running operation.",
"id": "RunWorkflowCustomOperationMetadata",
"properties": {
"apiVersion": {
"description": "Output only. API version used to start the operation.",
"readOnly": true,
"type": "string"
},
"createTime": {
"description": "Output only. The time the operation was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"endTime": {
"description": "Output only. The time the operation finished running.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"pipelineRunId": {
"description": "Output only. ID of the pipeline run created by RunWorkflow.",
"readOnly": true,
"type": "string"
},
"requestedCancellation": {
"description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.",
"readOnly": true,
"type": "boolean"
},
"target": {
"description": "Output only. Server-defined resource path for the target of the operation.",
"readOnly": true,
"type": "string"
},
"verb": {
"description": "Output only. Name of the verb executed by the operation.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"SMTPDelivery": {
"description": "SMTPDelivery is the delivery configuration for an SMTP (email) notification.",
"id": "SMTPDelivery",
@@ -1263,7 +1821,7 @@
},
"storageSourceManifest": {
"$ref": "StorageSourceManifest",
"description": "If provided, get the source from this manifest in Google Cloud Storage. This feature is in Preview."
"description": "If provided, get the source from this manifest in Google Cloud Storage. This feature is in Preview; see description [here](https://github.com/GoogleCloudPlatform/cloud-builders/tree/master/gcs-fetcher)."
}
},
"type": "object"
@@ -1336,14 +1894,14 @@
"type": "string"
},
"object": {
"description": "Google Cloud Storage object containing the source. This object must be a gzipped archive file (`.tar.gz`) containing source to build.",
"description": "Google Cloud Storage object containing the source. This object must be a zipped (`.zip`) or gzipped archive file (`.tar.gz`) containing source to build.",
"type": "string"
}
},
"type": "object"
},
"StorageSourceManifest": {
"description": "Location of the source manifest in Google Cloud Storage. This feature is in Preview.",
"description": "Location of the source manifest in Google Cloud Storage. This feature is in Preview; see description [here](https://github.com/GoogleCloudPlatform/cloud-builders/tree/master/gcs-fetcher).",
"id": "StorageSourceManifest",
"properties": {
"bucket": {
@@ -1379,6 +1937,90 @@
},
"type": "object"
},
"UpdateBitbucketServerConfigOperationMetadata": {
"description": "Metadata for `UpdateBitbucketServerConfig` operation.",
"id": "UpdateBitbucketServerConfigOperationMetadata",
"properties": {
"bitbucketServerConfig": {
"description": "The resource name of the BitbucketServerConfig to be updated. Format: `projects/{project}/locations/{location}/bitbucketServerConfigs/{id}`.",
"type": "string"
},
"completeTime": {
"description": "Time the operation was completed.",
"format": "google-datetime",
"type": "string"
},
"createTime": {
"description": "Time the operation was created.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"UpdateGitHubEnterpriseConfigOperationMetadata": {
"description": "Metadata for `UpdateGitHubEnterpriseConfig` operation.",
"id": "UpdateGitHubEnterpriseConfigOperationMetadata",
"properties": {
"completeTime": {
"description": "Time the operation was completed.",
"format": "google-datetime",
"type": "string"
},
"createTime": {
"description": "Time the operation was created.",
"format": "google-datetime",
"type": "string"
},
"githubEnterpriseConfig": {
"description": "The resource name of the GitHubEnterprise to be updated. Format: `projects/{project}/locations/{location}/githubEnterpriseConfigs/{id}`.",
"type": "string"
}
},
"type": "object"
},
"UpdateGitLabConfigOperationMetadata": {
"description": "Metadata for `UpdateGitLabConfig` operation.",
"id": "UpdateGitLabConfigOperationMetadata",
"properties": {
"completeTime": {
"description": "Time the operation was completed.",
"format": "google-datetime",
"type": "string"
},
"createTime": {
"description": "Time the operation was created.",
"format": "google-datetime",
"type": "string"
},
"gitlabConfig": {
"description": "The resource name of the GitLabConfig to be created. Format: `projects/{project}/locations/{location}/gitlabConfigs/{id}`.",
"type": "string"
}
},
"type": "object"
},
"UpdateWorkerPoolOperationMetadata": {
"description": "Metadata for the `UpdateWorkerPool` operation.",
"id": "UpdateWorkerPoolOperationMetadata",
"properties": {
"completeTime": {
"description": "Time the operation was completed.",
"format": "google-datetime",
"type": "string"
},
"createTime": {
"description": "Time the operation was created.",
"format": "google-datetime",
"type": "string"
},
"workerPool": {
"description": "The resource name of the `WorkerPool` being updated. Format: `projects/{project}/locations/{location}/workerPools/{worker_pool}`.",
"type": "string"
}
},
"type": "object"
},
"Volume": {
"description": "Volume describes a Docker container volume which is mounted into build steps in order to persist files across build step execution.",
"id": "Volume",
@@ -1394,6 +2036,33 @@
},
"type": "object"
},
"Warning": {
"description": "A non-fatal problem encountered during the execution of the build.",
"id": "Warning",
"properties": {
"priority": {
"description": "The priority for this warning.",
"enum": [
"PRIORITY_UNSPECIFIED",
"INFO",
"WARNING",
"ALERT"
],
"enumDescriptions": [
"Should not be used.",
"e.g. deprecation warnings and alternative feature highlights.",
"e.g. automated detection of possible issues with the build.",
"e.g. alerts that a feature used in the build is pending removal"
],
"type": "string"
},
"text": {
"description": "Explanation of the warning generated.",
"type": "string"
}
},
"type": "object"
},
"WorkerConfig": {
"description": "WorkerConfig defines the configuration to be used for a creating workers in the pool.",
"id": "WorkerConfig",

693
etc/api/cloudbuild/v1alpha2/cloudbuild-api.json
View File

@@ -3,7 +3,7 @@
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "See, edit, configure, and delete your Google Cloud Platform data"
"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
}
}
}
@@ -317,9 +317,60 @@
}
}
},
"revision": "20210329",
"revision": "20220218",
"rootUrl": "https://cloudbuild.googleapis.com/",
"schemas": {
"ApprovalConfig": {
"description": "ApprovalConfig describes configuration for manual approval of a build.",
"id": "ApprovalConfig",
"properties": {
"approvalRequired": {
"description": "Whether or not approval is needed. If this is set on a build, it will become pending when created, and will need to be explicitly approved to start.",
"type": "boolean"
}
},
"type": "object"
},
"ApprovalResult": {
"description": "ApprovalResult describes the decision and associated metadata of a manual approval of a build.",
"id": "ApprovalResult",
"properties": {
"approvalTime": {
"description": "Output only. The time when the approval decision was made.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"approverAccount": {
"description": "Output only. Email of the user that called the ApproveBuild API to approve or reject a build at the time that the API was called.",
"readOnly": true,
"type": "string"
},
"comment": {
"description": "Optional. An optional comment for this manual approval result.",
"type": "string"
},
"decision": {
"description": "Required. The decision of this manual approval.",
"enum": [
"DECISION_UNSPECIFIED",
"APPROVED",
"REJECTED"
],
"enumDescriptions": [
"Default enum type. This should not be used.",
"Build is approved.",
"Build is rejected."
],
"type": "string"
},
"url": {
"description": "Optional. An optional URL tied to this manual approval result. This field is essentially the same as comment, except that it will be rendered by the UI differently. An example use case is a link to an external job that approved this Build.",
"type": "string"
}
},
"type": "object"
},
"ArtifactObjects": {
"description": "Files in the workspace to upload to Cloud Storage upon successful completion of all build steps.",
"id": "ArtifactObjects",
@@ -379,10 +430,91 @@
},
"type": "object"
},
"BatchCreateBitbucketServerConnectedRepositoriesResponse": {
"description": "Response of BatchCreateBitbucketServerConnectedRepositories RPC method including all successfully connected Bitbucket Server repositories.",
"id": "BatchCreateBitbucketServerConnectedRepositoriesResponse",
"properties": {
"bitbucketServerConnectedRepositories": {
"description": "The connected Bitbucket Server repositories.",
"items": {
"$ref": "BitbucketServerConnectedRepository"
},
"type": "array"
}
},
"type": "object"
},
"BatchCreateBitbucketServerConnectedRepositoriesResponseMetadata": {
"description": "Metadata for `BatchCreateBitbucketServerConnectedRepositories` operation.",
"id": "BatchCreateBitbucketServerConnectedRepositoriesResponseMetadata",
"properties": {
"completeTime": {
"description": "Time the operation was completed.",
"format": "google-datetime",
"type": "string"
},
"config": {
"description": "The name of the `BitbucketServerConfig` that added connected repositories. Format: `projects/{project}/locations/{location}/bitbucketServerConfigs/{config}`",
"type": "string"
},
"createTime": {
"description": "Time the operation was created.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"BitbucketServerConnectedRepository": {
"description": "/ BitbucketServerConnectedRepository represents a connected Bitbucket Server / repository.",
"id": "BitbucketServerConnectedRepository",
"properties": {
"parent": {
"description": "The name of the `BitbucketServerConfig` that added connected repository. Format: `projects/{project}/locations/{location}/bitbucketServerConfigs/{config}`",
"type": "string"
},
"repo": {
"$ref": "BitbucketServerRepositoryId",
"description": "The Bitbucket Server repositories to connect."
},
"status": {
"$ref": "Status",
"description": "Output only. The status of the repo connection request.",
"readOnly": true
}
},
"type": "object"
},
"BitbucketServerRepositoryId": {
"description": "BitbucketServerRepositoryId identifies a specific repository hosted on a Bitbucket Server.",
"id": "BitbucketServerRepositoryId",
"properties": {
"projectKey": {
"description": "Required. Identifier for the project storing the repository.",
"type": "string"
},
"repoSlug": {
"description": "Required. Identifier for the repository.",
"type": "string"
},
"webhookId": {
"description": "Output only. The ID of the webhook that was created for receiving events from this repo. We only create and manage a single webhook for each repo.",
"format": "int32",
"readOnly": true,
"type": "integer"
}
},
"type": "object"
},
"Build": {
"description": "A build resource in the Cloud Build API. At a high level, a `Build` describes where to find source code, how to build it (for example, the builder image to run on the source), and where to store the built artifacts. Fields can include the following variables, which will be expanded when the build is created: - $PROJECT_ID: the project ID of the build. - $PROJECT_NUMBER: the project number of the build. - $BUILD_ID: the autogenerated ID of the build. - $REPO_NAME: the source repository name specified by RepoSource. - $BRANCH_NAME: the branch name specified by RepoSource. - $TAG_NAME: the tag name specified by RepoSource. - $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or resolved from the specified branch or tag. - $SHORT_SHA: first 7 characters of $REVISION_ID or $COMMIT_SHA.",
"description": "A build resource in the Cloud Build API. At a high level, a `Build` describes where to find source code, how to build it (for example, the builder image to run on the source), and where to store the built artifacts. Fields can include the following variables, which will be expanded when the build is created: - $PROJECT_ID: the project ID of the build. - $PROJECT_NUMBER: the project number of the build. - $LOCATION: the location/region of the build. - $BUILD_ID: the autogenerated ID of the build. - $REPO_NAME: the source repository name specified by RepoSource. - $BRANCH_NAME: the branch name specified by RepoSource. - $TAG_NAME: the tag name specified by RepoSource. - $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or resolved from the specified branch or tag. - $SHORT_SHA: first 7 characters of $REVISION_ID or $COMMIT_SHA.",
"id": "Build",
"properties": {
"approval": {
"$ref": "BuildApproval",
"description": "Output only. Describes this build's approval configuration, status, and result.",
"readOnly": true
},
"artifacts": {
"$ref": "Artifacts",
"description": "Artifacts produced by the build that should be uploaded upon successful completion of all build steps."
@@ -402,6 +534,11 @@
"readOnly": true,
"type": "string"
},
"failureInfo": {
"$ref": "FailureInfo",
"description": "Output only. Contains information about the build when status=FAILURE.",
"readOnly": true
},
"finishTime": {
"description": "Output only. Time at which execution of the build was finished. The difference between finish_time and start_time is the duration of the build's execution.",
"format": "google-datetime",
@@ -461,7 +598,7 @@
"type": "array"
},
"serviceAccount": {
"description": "IAM service account whose credentials will be used at build runtime. Must be of the format `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. ACCOUNT can be email address or uniqueId of the service account. This field is in beta.",
"description": "IAM service account whose credentials will be used at build runtime. Must be of the format `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. ACCOUNT can be email address or uniqueId of the service account. ",
"type": "string"
},
"source": {
@@ -483,6 +620,7 @@
"description": "Output only. Status of the build.",
"enum": [
"STATUS_UNKNOWN",
"PENDING",
"QUEUED",
"WORKING",
"SUCCESS",
@@ -494,6 +632,7 @@
],
"enumDescriptions": [
"Status of the build is unknown.",
"Build has been created and is pending execution and queuing. It has not been queued.",
"Build or step is queued; work has not yet begun.",
"Build or step is being executed.",
"Build or step finished successfully.",
@@ -541,9 +680,53 @@
"additionalProperties": {
"$ref": "TimeSpan"
},
"description": "Output only. Stores timing information for phases of the build. Valid keys are: * BUILD: time to execute all build steps * PUSH: time to push all specified images. * FETCHSOURCE: time to fetch source. If the build does not specify source or images, these keys will not be included.",
"description": "Output only. Stores timing information for phases of the build. Valid keys are: * BUILD: time to execute all build steps. * PUSH: time to push all specified images. * FETCHSOURCE: time to fetch source. * SETUPBUILD: time to set up build. If the build does not specify source or images, these keys will not be included.",
"readOnly": true,
"type": "object"
},
"warnings": {
"description": "Output only. Non-fatal problems encountered during the execution of the build.",
"items": {
"$ref": "Warning"
},
"readOnly": true,
"type": "array"
}
},
"type": "object"
},
"BuildApproval": {
"description": "BuildApproval describes a build's approval configuration, state, and result.",
"id": "BuildApproval",
"properties": {
"config": {
"$ref": "ApprovalConfig",
"description": "Output only. Configuration for manual approval of this build.",
"readOnly": true
},
"result": {
"$ref": "ApprovalResult",
"description": "Output only. Result of manual approval for this Build.",
"readOnly": true
},
"state": {
"description": "Output only. The state of this build's approval.",
"enum": [
"STATE_UNSPECIFIED",
"PENDING",
"APPROVED",
"REJECTED",
"CANCELLED"
],
"enumDescriptions": [
"Default enum type. This should not be used.",
"Build approval is pending.",
"Build approval has been approved.",
"Build approval has been rejected.",
"Build was cancelled while it was still pending approval."
],
"readOnly": true,
"type": "string"
}
},
"type": "object"
@@ -605,10 +788,10 @@
],
"enumDescriptions": [
"The service determines the logging mode. The default is `LEGACY`. Do not rely on the default logging behavior as it may change in the future.",
"Cloud Logging and Cloud Storage logging are enabled.",
"Only Cloud Storage logging is enabled.",
"Build logs are stored in Cloud Logging and Cloud Storage.",
"Build logs are stored in Cloud Storage.",
"This option is the same as CLOUD_LOGGING_ONLY.",
"Only Cloud Logging is enabled. Note that logs for both the Cloud Console UI and Cloud SDK are based on Cloud Storage logs, so neither will provide logs if this option is chosen.",
"Build logs are stored in Cloud Logging. Selecting this option will not allow [logs streaming](https://cloud.google.com/sdk/gcloud/reference/builds/log).",
"Turn off all logging. No build logs will be captured."
],
"type": "string"
@@ -631,6 +814,10 @@
],
"type": "string"
},
"pool": {
"$ref": "PoolOption",
"description": "Optional. Specification for execution on a `WorkerPool`. See [running builds in a private pool](https://cloud.google.com/build/docs/private-pools/run-builds-in-private-pool) for more information."
},
"requestedVerifyOption": {
"description": "Requested verifiability options.",
"enum": [
@@ -687,7 +874,7 @@
"type": "array"
},
"workerPool": {
"description": "Option to specify a `WorkerPool` for the build. Format: projects/{project}/locations/{location}/workerPools/{workerPool} This field is in beta and is available only to restricted users.",
"description": "This field deprecated; please use `pool.name` instead.",
"type": "string"
}
},
@@ -732,6 +919,10 @@
"description": "Output only. Stores timing information for pulling this build step's builder image only.",
"readOnly": true
},
"script": {
"description": "A shell script to be executed in the step. When script is provided, the user cannot specify the entrypoint or args.",
"type": "string"
},
"secretEnv": {
"description": "A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's `Secret`.",
"items": {
@@ -743,6 +934,7 @@
"description": "Output only. Status of the build step. At this time, build step status is only updated on build completion; step status is not updated in real-time as the build progresses.",
"enum": [
"STATUS_UNKNOWN",
"PENDING",
"QUEUED",
"WORKING",
"SUCCESS",
@@ -754,6 +946,7 @@
],
"enumDescriptions": [
"Status of the build is unknown.",
"Build has been created and is pending execution and queuing. It has not been queued.",
"Build or step is queued; work has not yet begun.",
"Build or step is being executed.",
"Build or step finished successfully.",
@@ -819,12 +1012,213 @@
"properties": {},
"type": "object"
},
"CreateBitbucketServerConfigOperationMetadata": {
"description": "Metadata for `CreateBitbucketServerConfig` operation.",
"id": "CreateBitbucketServerConfigOperationMetadata",
"properties": {
"bitbucketServerConfig": {
"description": "The resource name of the BitbucketServerConfig to be created. Format: `projects/{project}/locations/{location}/bitbucketServerConfigs/{id}`.",
"type": "string"
},
"completeTime": {
"description": "Time the operation was completed.",
"format": "google-datetime",
"type": "string"
},
"createTime": {
"description": "Time the operation was created.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"CreateGitHubEnterpriseConfigOperationMetadata": {
"description": "Metadata for `CreateGithubEnterpriseConfig` operation.",
"id": "CreateGitHubEnterpriseConfigOperationMetadata",
"properties": {
"completeTime": {
"description": "Time the operation was completed.",
"format": "google-datetime",
"type": "string"
},
"createTime": {
"description": "Time the operation was created.",
"format": "google-datetime",
"type": "string"
},
"githubEnterpriseConfig": {
"description": "The resource name of the GitHubEnterprise to be created. Format: `projects/{project}/locations/{location}/githubEnterpriseConfigs/{id}`.",
"type": "string"
}
},
"type": "object"
},
"CreateGitLabConfigOperationMetadata": {
"description": "Metadata for `CreateGitLabConfig` operation.",
"id": "CreateGitLabConfigOperationMetadata",
"properties": {
"completeTime": {
"description": "Time the operation was completed.",
"format": "google-datetime",
"type": "string"
},
"createTime": {
"description": "Time the operation was created.",
"format": "google-datetime",
"type": "string"
},
"gitlabConfig": {
"description": "The resource name of the GitLabConfig to be created. Format: `projects/{project}/locations/{location}/gitlabConfigs/{id}`.",
"type": "string"
}
},
"type": "object"
},
"CreateWorkerPoolOperationMetadata": {
"description": "Metadata for the `CreateWorkerPool` operation.",
"id": "CreateWorkerPoolOperationMetadata",
"properties": {
"completeTime": {
"description": "Time the operation was completed.",
"format": "google-datetime",
"type": "string"
},
"createTime": {
"description": "Time the operation was created.",
"format": "google-datetime",
"type": "string"
},
"workerPool": {
"description": "The resource name of the `WorkerPool` to create. Format: `projects/{project}/locations/{location}/workerPools/{worker_pool}`.",
"type": "string"
}
},
"type": "object"
},
"DeleteBitbucketServerConfigOperationMetadata": {
"description": "Metadata for `DeleteBitbucketServerConfig` operation.",
"id": "DeleteBitbucketServerConfigOperationMetadata",
"properties": {
"bitbucketServerConfig": {
"description": "The resource name of the BitbucketServerConfig to be deleted. Format: `projects/{project}/locations/{location}/bitbucketServerConfigs/{id}`.",
"type": "string"
},
"completeTime": {
"description": "Time the operation was completed.",
"format": "google-datetime",
"type": "string"
},
"createTime": {
"description": "Time the operation was created.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"DeleteGitHubEnterpriseConfigOperationMetadata": {
"description": "Metadata for `DeleteGitHubEnterpriseConfig` operation.",
"id": "DeleteGitHubEnterpriseConfigOperationMetadata",
"properties": {
"completeTime": {
"description": "Time the operation was completed.",
"format": "google-datetime",
"type": "string"
},
"createTime": {
"description": "Time the operation was created.",
"format": "google-datetime",
"type": "string"
},
"githubEnterpriseConfig": {
"description": "The resource name of the GitHubEnterprise to be deleted. Format: `projects/{project}/locations/{location}/githubEnterpriseConfigs/{id}`.",
"type": "string"
}
},
"type": "object"
},
"DeleteGitLabConfigOperationMetadata": {
"description": "Metadata for `DeleteGitLabConfig` operation.",
"id": "DeleteGitLabConfigOperationMetadata",
"properties": {
"completeTime": {
"description": "Time the operation was completed.",
"format": "google-datetime",
"type": "string"
},
"createTime": {
"description": "Time the operation was created.",
"format": "google-datetime",
"type": "string"
},
"gitlabConfig": {
"description": "The resource name of the GitLabConfig to be created. Format: `projects/{project}/locations/{location}/gitlabConfigs/{id}`.",
"type": "string"
}
},
"type": "object"
},
"DeleteWorkerPoolOperationMetadata": {
"description": "Metadata for the `DeleteWorkerPool` operation.",
"id": "DeleteWorkerPoolOperationMetadata",
"properties": {
"completeTime": {
"description": "Time the operation was completed.",
"format": "google-datetime",
"type": "string"
},
"createTime": {
"description": "Time the operation was created.",
"format": "google-datetime",
"type": "string"
},
"workerPool": {
"description": "The resource name of the `WorkerPool` being deleted. Format: `projects/{project}/locations/{location}/workerPools/{worker_pool}`.",
"type": "string"
}
},
"type": "object"
},
"Empty": {
"description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.",
"id": "Empty",
"properties": {},
"type": "object"
},
"FailureInfo": {
"description": "A fatal problem encountered during the execution of the build.",
"id": "FailureInfo",
"properties": {
"detail": {
"description": "Explains the failure issue in more detail using hard-coded text.",
"type": "string"
},
"type": {
"description": "The name of the failure.",
"enum": [
"FAILURE_TYPE_UNSPECIFIED",
"PUSH_FAILED",
"PUSH_IMAGE_NOT_FOUND",
"PUSH_NOT_AUTHORIZED",
"LOGGING_FAILURE",
"USER_BUILD_STEP",
"FETCH_SOURCE_FAILED"
],
"enumDescriptions": [
"Type unspecified",
"Unable to push the image to the repository.",
"Final image not found.",
"Unauthorized push of the final image.",
"Backend logging failures. Should retry.",
"A build step has failed.",
"The source fetching has failed."
],
"type": "string"
}
},
"type": "object"
},
"FileHashes": {
"description": "Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build.",
"id": "FileHashes",
@@ -839,6 +1233,50 @@
},
"type": "object"
},
"GoogleDevtoolsCloudbuildV2OperationMetadata": {
"description": "Represents the metadata of the long-running operation.",
"id": "GoogleDevtoolsCloudbuildV2OperationMetadata",
"properties": {
"apiVersion": {
"description": "Output only. API version used to start the operation.",
"readOnly": true,
"type": "string"
},
"createTime": {
"description": "Output only. The time the operation was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"endTime": {
"description": "Output only. The time the operation finished running.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"requestedCancellation": {
"description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.",
"readOnly": true,
"type": "boolean"
},
"statusMessage": {
"description": "Output only. Human-readable status of the operation, if any.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Output only. Server-defined resource path for the target of the operation.",
"readOnly": true,
"type": "string"
},
"verb": {
"description": "Output only. Name of the verb executed by the operation.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"HTTPDelivery": {
"description": "HTTPDelivery is the delivery configuration for an HTTP notification.",
"id": "HTTPDelivery",
@@ -1068,6 +1506,82 @@
},
"type": "object"
},
"OperationMetadata": {
"description": "Represents the metadata of the long-running operation.",
"id": "OperationMetadata",
"properties": {
"apiVersion": {
"description": "Output only. API version used to start the operation.",
"readOnly": true,
"type": "string"
},
"cancelRequested": {
"description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.",
"readOnly": true,
"type": "boolean"
},
"createTime": {
"description": "Output only. The time the operation was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"endTime": {
"description": "Output only. The time the operation finished running.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"statusDetail": {
"description": "Output only. Human-readable status of the operation, if any.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Output only. Server-defined resource path for the target of the operation.",
"readOnly": true,
"type": "string"
},
"verb": {
"description": "Output only. Name of the verb executed by the operation.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"PoolOption": {
"description": "Details about how a build should be executed on a `WorkerPool`. See [running builds in a private pool](https://cloud.google.com/build/docs/private-pools/run-builds-in-private-pool) for more information.",
"id": "PoolOption",
"properties": {
"name": {
"description": "The `WorkerPool` resource to execute the build on. You must have `cloudbuild.workerpools.use` on the project hosting the WorkerPool. Format projects/{project}/locations/{location}/workerPools/{workerPoolId}",
"type": "string"
}
},
"type": "object"
},
"ProcessAppManifestCallbackOperationMetadata": {
"description": "Metadata for `ProcessAppManifestCallback` operation.",
"id": "ProcessAppManifestCallbackOperationMetadata",
"properties": {
"completeTime": {
"description": "Time the operation was completed.",
"format": "google-datetime",
"type": "string"
},
"createTime": {
"description": "Time the operation was created.",
"format": "google-datetime",
"type": "string"
},
"githubEnterpriseConfig": {
"description": "The resource name of the GitHubEnterprise to be created. Format: `projects/{project}/locations/{location}/githubEnterpriseConfigs/{id}`.",
"type": "string"
}
},
"type": "object"
},
"RepoSource": {
"description": "Location of the source in a Google Cloud Source Repository.",
"id": "RepoSource",
@@ -1152,6 +1666,50 @@
},
"type": "object"
},
"RunWorkflowCustomOperationMetadata": {
"description": "Represents the custom metadata of the RunWorkflow long-running operation.",
"id": "RunWorkflowCustomOperationMetadata",
"properties": {
"apiVersion": {
"description": "Output only. API version used to start the operation.",
"readOnly": true,
"type": "string"
},
"createTime": {
"description": "Output only. The time the operation was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"endTime": {
"description": "Output only. The time the operation finished running.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"pipelineRunId": {
"description": "Output only. ID of the pipeline run created by RunWorkflow.",
"readOnly": true,
"type": "string"
},
"requestedCancellation": {
"description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.",
"readOnly": true,
"type": "boolean"
},
"target": {
"description": "Output only. Server-defined resource path for the target of the operation.",
"readOnly": true,
"type": "string"
},
"verb": {
"description": "Output only. Name of the verb executed by the operation.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"SMTPDelivery": {
"description": "SMTPDelivery is the delivery configuration for an SMTP (email) notification.",
"id": "SMTPDelivery",
@@ -1266,7 +1824,7 @@
},
"storageSourceManifest": {
"$ref": "StorageSourceManifest",
"description": "If provided, get the source from this manifest in Google Cloud Storage. This feature is in Preview."
"description": "If provided, get the source from this manifest in Google Cloud Storage. This feature is in Preview; see description [here](https://github.com/GoogleCloudPlatform/cloud-builders/tree/master/gcs-fetcher)."
}
},
"type": "object"
@@ -1339,14 +1897,14 @@
"type": "string"
},
"object": {
"description": "Google Cloud Storage object containing the source. This object must be a gzipped archive file (`.tar.gz`) containing source to build.",
"description": "Google Cloud Storage object containing the source. This object must be a zipped (`.zip`) or gzipped archive file (`.tar.gz`) containing source to build.",
"type": "string"
}
},
"type": "object"
},
"StorageSourceManifest": {
"description": "Location of the source manifest in Google Cloud Storage. This feature is in Preview.",
"description": "Location of the source manifest in Google Cloud Storage. This feature is in Preview; see description [here](https://github.com/GoogleCloudPlatform/cloud-builders/tree/master/gcs-fetcher).",
"id": "StorageSourceManifest",
"properties": {
"bucket": {
@@ -1382,6 +1940,90 @@
},
"type": "object"
},
"UpdateBitbucketServerConfigOperationMetadata": {
"description": "Metadata for `UpdateBitbucketServerConfig` operation.",
"id": "UpdateBitbucketServerConfigOperationMetadata",
"properties": {
"bitbucketServerConfig": {
"description": "The resource name of the BitbucketServerConfig to be updated. Format: `projects/{project}/locations/{location}/bitbucketServerConfigs/{id}`.",
"type": "string"
},
"completeTime": {
"description": "Time the operation was completed.",
"format": "google-datetime",
"type": "string"
},
"createTime": {
"description": "Time the operation was created.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"UpdateGitHubEnterpriseConfigOperationMetadata": {
"description": "Metadata for `UpdateGitHubEnterpriseConfig` operation.",
"id": "UpdateGitHubEnterpriseConfigOperationMetadata",
"properties": {
"completeTime": {
"description": "Time the operation was completed.",
"format": "google-datetime",
"type": "string"
},
"createTime": {
"description": "Time the operation was created.",
"format": "google-datetime",
"type": "string"
},
"githubEnterpriseConfig": {
"description": "The resource name of the GitHubEnterprise to be updated. Format: `projects/{project}/locations/{location}/githubEnterpriseConfigs/{id}`.",
"type": "string"
}
},
"type": "object"
},
"UpdateGitLabConfigOperationMetadata": {
"description": "Metadata for `UpdateGitLabConfig` operation.",
"id": "UpdateGitLabConfigOperationMetadata",
"properties": {
"completeTime": {
"description": "Time the operation was completed.",
"format": "google-datetime",
"type": "string"
},
"createTime": {
"description": "Time the operation was created.",
"format": "google-datetime",
"type": "string"
},
"gitlabConfig": {
"description": "The resource name of the GitLabConfig to be created. Format: `projects/{project}/locations/{location}/gitlabConfigs/{id}`.",
"type": "string"
}
},
"type": "object"
},
"UpdateWorkerPoolOperationMetadata": {
"description": "Metadata for the `UpdateWorkerPool` operation.",
"id": "UpdateWorkerPoolOperationMetadata",
"properties": {
"completeTime": {
"description": "Time the operation was completed.",
"format": "google-datetime",
"type": "string"
},
"createTime": {
"description": "Time the operation was created.",
"format": "google-datetime",
"type": "string"
},
"workerPool": {
"description": "The resource name of the `WorkerPool` being updated. Format: `projects/{project}/locations/{location}/workerPools/{worker_pool}`.",
"type": "string"
}
},
"type": "object"
},
"Volume": {
"description": "Volume describes a Docker container volume which is mounted into build steps in order to persist files across build step execution.",
"id": "Volume",
@@ -1397,6 +2039,33 @@
},
"type": "object"
},
"Warning": {
"description": "A non-fatal problem encountered during the execution of the build.",
"id": "Warning",
"properties": {
"priority": {
"description": "The priority for this warning.",
"enum": [
"PRIORITY_UNSPECIFIED",
"INFO",
"WARNING",
"ALERT"
],
"enumDescriptions": [
"Should not be used.",
"e.g. deprecation warnings and alternative feature highlights.",
"e.g. automated detection of possible issues with the build.",
"e.g. alerts that a feature used in the build is pending removal"
],
"type": "string"
},
"text": {
"description": "Explanation of the warning generated.",
"type": "string"
}
},
"type": "object"
},
"WorkerConfig": {
"description": "WorkerConfig defines the configuration to be used for a creating workers in the pool.",
"id": "WorkerConfig",

719
etc/api/cloudbuild/v1beta1/cloudbuild-api.json
View File

@@ -3,7 +3,7 @@
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "See, edit, configure, and delete your Google Cloud Platform data"
"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
}
}
}
@@ -210,6 +210,11 @@
"name"
],
"parameters": {
"etag": {
"description": "Optional. If this is provided, it must match the server's etag on the workerpool for the request to be processed.",
"location": "query",
"type": "string"
},
"name": {
"description": "Required. The name of the `WorkerPool` to delete. Format: `projects/{project}/locations/{workerPool}/workerPools/{workerPool}`.",
"location": "path",
@@ -317,9 +322,60 @@
}
}
},
"revision": "20210329",
"revision": "20220218",
"rootUrl": "https://cloudbuild.googleapis.com/",
"schemas": {
"ApprovalConfig": {
"description": "ApprovalConfig describes configuration for manual approval of a build.",
"id": "ApprovalConfig",
"properties": {
"approvalRequired": {
"description": "Whether or not approval is needed. If this is set on a build, it will become pending when created, and will need to be explicitly approved to start.",
"type": "boolean"
}
},
"type": "object"
},
"ApprovalResult": {
"description": "ApprovalResult describes the decision and associated metadata of a manual approval of a build.",
"id": "ApprovalResult",
"properties": {
"approvalTime": {
"description": "Output only. The time when the approval decision was made.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"approverAccount": {
"description": "Output only. Email of the user that called the ApproveBuild API to approve or reject a build at the time that the API was called.",
"readOnly": true,
"type": "string"
},
"comment": {
"description": "Optional. An optional comment for this manual approval result.",
"type": "string"
},
"decision": {
"description": "Required. The decision of this manual approval.",
"enum": [
"DECISION_UNSPECIFIED",
"APPROVED",
"REJECTED"
],
"enumDescriptions": [
"Default enum type. This should not be used.",
"Build is approved.",
"Build is rejected."
],
"type": "string"
},
"url": {
"description": "Optional. An optional URL tied to this manual approval result. This field is essentially the same as comment, except that it will be rendered by the UI differently. An example use case is a link to an external job that approved this Build.",
"type": "string"
}
},
"type": "object"
},
"ArtifactObjects": {
"description": "Files in the workspace to upload to Cloud Storage upon successful completion of all build steps.",
"id": "ArtifactObjects",
@@ -379,10 +435,91 @@
},
"type": "object"
},
"BatchCreateBitbucketServerConnectedRepositoriesResponse": {
"description": "Response of BatchCreateBitbucketServerConnectedRepositories RPC method including all successfully connected Bitbucket Server repositories.",
"id": "BatchCreateBitbucketServerConnectedRepositoriesResponse",
"properties": {
"bitbucketServerConnectedRepositories": {
"description": "The connected Bitbucket Server repositories.",
"items": {
"$ref": "BitbucketServerConnectedRepository"
},
"type": "array"
}
},
"type": "object"
},
"BatchCreateBitbucketServerConnectedRepositoriesResponseMetadata": {
"description": "Metadata for `BatchCreateBitbucketServerConnectedRepositories` operation.",
"id": "BatchCreateBitbucketServerConnectedRepositoriesResponseMetadata",
"properties": {
"completeTime": {
"description": "Time the operation was completed.",
"format": "google-datetime",
"type": "string"
},
"config": {
"description": "The name of the `BitbucketServerConfig` that added connected repositories. Format: `projects/{project}/locations/{location}/bitbucketServerConfigs/{config}`",
"type": "string"
},
"createTime": {
"description": "Time the operation was created.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"BitbucketServerConnectedRepository": {
"description": "/ BitbucketServerConnectedRepository represents a connected Bitbucket Server / repository.",
"id": "BitbucketServerConnectedRepository",
"properties": {
"parent": {
"description": "The name of the `BitbucketServerConfig` that added connected repository. Format: `projects/{project}/locations/{location}/bitbucketServerConfigs/{config}`",
"type": "string"
},
"repo": {
"$ref": "BitbucketServerRepositoryId",
"description": "The Bitbucket Server repositories to connect."
},
"status": {
"$ref": "Status",
"description": "Output only. The status of the repo connection request.",
"readOnly": true
}
},
"type": "object"
},
"BitbucketServerRepositoryId": {
"description": "BitbucketServerRepositoryId identifies a specific repository hosted on a Bitbucket Server.",
"id": "BitbucketServerRepositoryId",
"properties": {
"projectKey": {
"description": "Required. Identifier for the project storing the repository.",
"type": "string"
},
"repoSlug": {
"description": "Required. Identifier for the repository.",
"type": "string"
},
"webhookId": {
"description": "Output only. The ID of the webhook that was created for receiving events from this repo. We only create and manage a single webhook for each repo.",
"format": "int32",
"readOnly": true,
"type": "integer"
}
},
"type": "object"
},
"Build": {
"description": "A build resource in the Cloud Build API. At a high level, a `Build` describes where to find source code, how to build it (for example, the builder image to run on the source), and where to store the built artifacts. Fields can include the following variables, which will be expanded when the build is created: - $PROJECT_ID: the project ID of the build. - $PROJECT_NUMBER: the project number of the build. - $BUILD_ID: the autogenerated ID of the build. - $REPO_NAME: the source repository name specified by RepoSource. - $BRANCH_NAME: the branch name specified by RepoSource. - $TAG_NAME: the tag name specified by RepoSource. - $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or resolved from the specified branch or tag. - $SHORT_SHA: first 7 characters of $REVISION_ID or $COMMIT_SHA.",
"description": "A build resource in the Cloud Build API. At a high level, a `Build` describes where to find source code, how to build it (for example, the builder image to run on the source), and where to store the built artifacts. Fields can include the following variables, which will be expanded when the build is created: - $PROJECT_ID: the project ID of the build. - $PROJECT_NUMBER: the project number of the build. - $LOCATION: the location/region of the build. - $BUILD_ID: the autogenerated ID of the build. - $REPO_NAME: the source repository name specified by RepoSource. - $BRANCH_NAME: the branch name specified by RepoSource. - $TAG_NAME: the tag name specified by RepoSource. - $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or resolved from the specified branch or tag. - $SHORT_SHA: first 7 characters of $REVISION_ID or $COMMIT_SHA.",
"id": "Build",
"properties": {
"approval": {
"$ref": "BuildApproval",
"description": "Output only. Describes this build's approval configuration, status, and result.",
"readOnly": true
},
"artifacts": {
"$ref": "Artifacts",
"description": "Artifacts produced by the build that should be uploaded upon successful completion of all build steps."
@@ -402,6 +539,11 @@
"readOnly": true,
"type": "string"
},
"failureInfo": {
"$ref": "FailureInfo",
"description": "Output only. Contains information about the build when status=FAILURE.",
"readOnly": true
},
"finishTime": {
"description": "Output only. Time at which execution of the build was finished. The difference between finish_time and start_time is the duration of the build's execution.",
"format": "google-datetime",
@@ -461,7 +603,7 @@
"type": "array"
},
"serviceAccount": {
"description": "IAM service account whose credentials will be used at build runtime. Must be of the format `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. ACCOUNT can be email address or uniqueId of the service account. This field is in beta.",
"description": "IAM service account whose credentials will be used at build runtime. Must be of the format `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. ACCOUNT can be email address or uniqueId of the service account. ",
"type": "string"
},
"source": {
@@ -483,6 +625,7 @@
"description": "Output only. Status of the build.",
"enum": [
"STATUS_UNKNOWN",
"PENDING",
"QUEUED",
"WORKING",
"SUCCESS",
@@ -494,6 +637,7 @@
],
"enumDescriptions": [
"Status of the build is unknown.",
"Build has been created and is pending execution and queuing. It has not been queued.",
"Build or step is queued; work has not yet begun.",
"Build or step is being executed.",
"Build or step finished successfully.",
@@ -541,9 +685,53 @@
"additionalProperties": {
"$ref": "TimeSpan"
},
"description": "Output only. Stores timing information for phases of the build. Valid keys are: * BUILD: time to execute all build steps * PUSH: time to push all specified images. * FETCHSOURCE: time to fetch source. If the build does not specify source or images, these keys will not be included.",
"description": "Output only. Stores timing information for phases of the build. Valid keys are: * BUILD: time to execute all build steps. * PUSH: time to push all specified images. * FETCHSOURCE: time to fetch source. * SETUPBUILD: time to set up build. If the build does not specify source or images, these keys will not be included.",
"readOnly": true,
"type": "object"
},
"warnings": {
"description": "Output only. Non-fatal problems encountered during the execution of the build.",
"items": {
"$ref": "Warning"
},
"readOnly": true,
"type": "array"
}
},
"type": "object"
},
"BuildApproval": {
"description": "BuildApproval describes a build's approval configuration, state, and result.",
"id": "BuildApproval",
"properties": {
"config": {
"$ref": "ApprovalConfig",
"description": "Output only. Configuration for manual approval of this build.",
"readOnly": true
},
"result": {
"$ref": "ApprovalResult",
"description": "Output only. Result of manual approval for this Build.",
"readOnly": true
},
"state": {
"description": "Output only. The state of this build's approval.",
"enum": [
"STATE_UNSPECIFIED",
"PENDING",
"APPROVED",
"REJECTED",
"CANCELLED"
],
"enumDescriptions": [
"Default enum type. This should not be used.",
"Build approval is pending.",
"Build approval has been approved.",
"Build approval has been rejected.",
"Build was cancelled while it was still pending approval."
],
"readOnly": true,
"type": "string"
}
},
"type": "object"
@@ -605,10 +793,10 @@
],
"enumDescriptions": [
"The service determines the logging mode. The default is `LEGACY`. Do not rely on the default logging behavior as it may change in the future.",
"Cloud Logging and Cloud Storage logging are enabled.",
"Only Cloud Storage logging is enabled.",
"Build logs are stored in Cloud Logging and Cloud Storage.",
"Build logs are stored in Cloud Storage.",
"This option is the same as CLOUD_LOGGING_ONLY.",
"Only Cloud Logging is enabled. Note that logs for both the Cloud Console UI and Cloud SDK are based on Cloud Storage logs, so neither will provide logs if this option is chosen.",
"Build logs are stored in Cloud Logging. Selecting this option will not allow [logs streaming](https://cloud.google.com/sdk/gcloud/reference/builds/log).",
"Turn off all logging. No build logs will be captured."
],
"type": "string"
@@ -631,6 +819,10 @@
],
"type": "string"
},
"pool": {
"$ref": "PoolOption",
"description": "Optional. Specification for execution on a `WorkerPool`. See [running builds in a private pool](https://cloud.google.com/build/docs/private-pools/run-builds-in-private-pool) for more information."
},
"requestedVerifyOption": {
"description": "Requested verifiability options.",
"enum": [
@@ -687,7 +879,7 @@
"type": "array"
},
"workerPool": {
"description": "Option to specify a `WorkerPool` for the build. Format: projects/{project}/locations/{location}/workerPools/{workerPool} This field is in beta and is available only to restricted users.",
"description": "This field deprecated; please use `pool.name` instead.",
"type": "string"
}
},
@@ -732,6 +924,10 @@
"description": "Output only. Stores timing information for pulling this build step's builder image only.",
"readOnly": true
},
"script": {
"description": "A shell script to be executed in the step. When script is provided, the user cannot specify the entrypoint or args.",
"type": "string"
},
"secretEnv": {
"description": "A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's `Secret`.",
"items": {
@@ -743,6 +939,7 @@
"description": "Output only. Status of the build step. At this time, build step status is only updated on build completion; step status is not updated in real-time as the build progresses.",
"enum": [
"STATUS_UNKNOWN",
"PENDING",
"QUEUED",
"WORKING",
"SUCCESS",
@@ -754,6 +951,7 @@
],
"enumDescriptions": [
"Status of the build is unknown.",
"Build has been created and is pending execution and queuing. It has not been queued.",
"Build or step is queued; work has not yet begun.",
"Build or step is being executed.",
"Build or step finished successfully.",
@@ -819,12 +1017,213 @@
"properties": {},
"type": "object"
},
"CreateBitbucketServerConfigOperationMetadata": {
"description": "Metadata for `CreateBitbucketServerConfig` operation.",
"id": "CreateBitbucketServerConfigOperationMetadata",
"properties": {
"bitbucketServerConfig": {
"description": "The resource name of the BitbucketServerConfig to be created. Format: `projects/{project}/locations/{location}/bitbucketServerConfigs/{id}`.",
"type": "string"
},
"completeTime": {
"description": "Time the operation was completed.",
"format": "google-datetime",
"type": "string"
},
"createTime": {
"description": "Time the operation was created.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"CreateGitHubEnterpriseConfigOperationMetadata": {
"description": "Metadata for `CreateGithubEnterpriseConfig` operation.",
"id": "CreateGitHubEnterpriseConfigOperationMetadata",
"properties": {
"completeTime": {
"description": "Time the operation was completed.",
"format": "google-datetime",
"type": "string"
},
"createTime": {
"description": "Time the operation was created.",
"format": "google-datetime",
"type": "string"
},
"githubEnterpriseConfig": {
"description": "The resource name of the GitHubEnterprise to be created. Format: `projects/{project}/locations/{location}/githubEnterpriseConfigs/{id}`.",
"type": "string"
}
},
"type": "object"
},
"CreateGitLabConfigOperationMetadata": {
"description": "Metadata for `CreateGitLabConfig` operation.",
"id": "CreateGitLabConfigOperationMetadata",
"properties": {
"completeTime": {
"description": "Time the operation was completed.",
"format": "google-datetime",
"type": "string"
},
"createTime": {
"description": "Time the operation was created.",
"format": "google-datetime",
"type": "string"
},
"gitlabConfig": {
"description": "The resource name of the GitLabConfig to be created. Format: `projects/{project}/locations/{location}/gitlabConfigs/{id}`.",
"type": "string"
}
},
"type": "object"
},
"CreateWorkerPoolOperationMetadata": {
"description": "Metadata for the `CreateWorkerPool` operation.",
"id": "CreateWorkerPoolOperationMetadata",
"properties": {
"completeTime": {
"description": "Time the operation was completed.",
"format": "google-datetime",
"type": "string"
},
"createTime": {
"description": "Time the operation was created.",
"format": "google-datetime",
"type": "string"
},
"workerPool": {
"description": "The resource name of the `WorkerPool` to create. Format: `projects/{project}/locations/{location}/workerPools/{worker_pool}`.",
"type": "string"
}
},
"type": "object"
},
"DeleteBitbucketServerConfigOperationMetadata": {
"description": "Metadata for `DeleteBitbucketServerConfig` operation.",
"id": "DeleteBitbucketServerConfigOperationMetadata",
"properties": {
"bitbucketServerConfig": {
"description": "The resource name of the BitbucketServerConfig to be deleted. Format: `projects/{project}/locations/{location}/bitbucketServerConfigs/{id}`.",
"type": "string"
},
"completeTime": {
"description": "Time the operation was completed.",
"format": "google-datetime",
"type": "string"
},
"createTime": {
"description": "Time the operation was created.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"DeleteGitHubEnterpriseConfigOperationMetadata": {
"description": "Metadata for `DeleteGitHubEnterpriseConfig` operation.",
"id": "DeleteGitHubEnterpriseConfigOperationMetadata",
"properties": {
"completeTime": {
"description": "Time the operation was completed.",
"format": "google-datetime",
"type": "string"
},
"createTime": {
"description": "Time the operation was created.",
"format": "google-datetime",
"type": "string"
},
"githubEnterpriseConfig": {
"description": "The resource name of the GitHubEnterprise to be deleted. Format: `projects/{project}/locations/{location}/githubEnterpriseConfigs/{id}`.",
"type": "string"
}
},
"type": "object"
},
"DeleteGitLabConfigOperationMetadata": {
"description": "Metadata for `DeleteGitLabConfig` operation.",
"id": "DeleteGitLabConfigOperationMetadata",
"properties": {
"completeTime": {
"description": "Time the operation was completed.",
"format": "google-datetime",
"type": "string"
},
"createTime": {
"description": "Time the operation was created.",
"format": "google-datetime",
"type": "string"
},
"gitlabConfig": {
"description": "The resource name of the GitLabConfig to be created. Format: `projects/{project}/locations/{location}/gitlabConfigs/{id}`.",
"type": "string"
}
},
"type": "object"
},
"DeleteWorkerPoolOperationMetadata": {
"description": "Metadata for the `DeleteWorkerPool` operation.",
"id": "DeleteWorkerPoolOperationMetadata",
"properties": {
"completeTime": {
"description": "Time the operation was completed.",
"format": "google-datetime",
"type": "string"
},
"createTime": {
"description": "Time the operation was created.",
"format": "google-datetime",
"type": "string"
},
"workerPool": {
"description": "The resource name of the `WorkerPool` being deleted. Format: `projects/{project}/locations/{location}/workerPools/{worker_pool}`.",
"type": "string"
}
},
"type": "object"
},
"Empty": {
"description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.",
"id": "Empty",
"properties": {},
"type": "object"
},
"FailureInfo": {
"description": "A fatal problem encountered during the execution of the build.",
"id": "FailureInfo",
"properties": {
"detail": {
"description": "Explains the failure issue in more detail using hard-coded text.",
"type": "string"
},
"type": {
"description": "The name of the failure.",
"enum": [
"FAILURE_TYPE_UNSPECIFIED",
"PUSH_FAILED",
"PUSH_IMAGE_NOT_FOUND",
"PUSH_NOT_AUTHORIZED",
"LOGGING_FAILURE",
"USER_BUILD_STEP",
"FETCH_SOURCE_FAILED"
],
"enumDescriptions": [
"Type unspecified",
"Unable to push the image to the repository.",
"Final image not found.",
"Unauthorized push of the final image.",
"Backend logging failures. Should retry.",
"A build step has failed.",
"The source fetching has failed."
],
"type": "string"
}
},
"type": "object"
},
"FileHashes": {
"description": "Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build.",
"id": "FileHashes",
@@ -839,6 +1238,50 @@
},
"type": "object"
},
"GoogleDevtoolsCloudbuildV2OperationMetadata": {
"description": "Represents the metadata of the long-running operation.",
"id": "GoogleDevtoolsCloudbuildV2OperationMetadata",
"properties": {
"apiVersion": {
"description": "Output only. API version used to start the operation.",
"readOnly": true,
"type": "string"
},
"createTime": {
"description": "Output only. The time the operation was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"endTime": {
"description": "Output only. The time the operation finished running.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"requestedCancellation": {
"description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.",
"readOnly": true,
"type": "boolean"
},
"statusMessage": {
"description": "Output only. Human-readable status of the operation, if any.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Output only. Server-defined resource path for the target of the operation.",
"readOnly": true,
"type": "string"
},
"verb": {
"description": "Output only. Name of the verb executed by the operation.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"HTTPDelivery": {
"description": "HTTPDelivery is the delivery configuration for an HTTP notification.",
"id": "HTTPDelivery",
@@ -1068,6 +1511,82 @@
},
"type": "object"
},
"OperationMetadata": {
"description": "Represents the metadata of the long-running operation.",
"id": "OperationMetadata",
"properties": {
"apiVersion": {
"description": "Output only. API version used to start the operation.",
"readOnly": true,
"type": "string"
},
"cancelRequested": {
"description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.",
"readOnly": true,
"type": "boolean"
},
"createTime": {
"description": "Output only. The time the operation was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"endTime": {
"description": "Output only. The time the operation finished running.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"statusDetail": {
"description": "Output only. Human-readable status of the operation, if any.",
"readOnly": true,
"type": "string"
},
"target": {
"description": "Output only. Server-defined resource path for the target of the operation.",
"readOnly": true,
"type": "string"
},
"verb": {
"description": "Output only. Name of the verb executed by the operation.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"PoolOption": {
"description": "Details about how a build should be executed on a `WorkerPool`. See [running builds in a private pool](https://cloud.google.com/build/docs/private-pools/run-builds-in-private-pool) for more information.",
"id": "PoolOption",
"properties": {
"name": {
"description": "The `WorkerPool` resource to execute the build on. You must have `cloudbuild.workerpools.use` on the project hosting the WorkerPool. Format projects/{project}/locations/{location}/workerPools/{workerPoolId}",
"type": "string"
}
},
"type": "object"
},
"ProcessAppManifestCallbackOperationMetadata": {
"description": "Metadata for `ProcessAppManifestCallback` operation.",
"id": "ProcessAppManifestCallbackOperationMetadata",
"properties": {
"completeTime": {
"description": "Time the operation was completed.",
"format": "google-datetime",
"type": "string"
},
"createTime": {
"description": "Time the operation was created.",
"format": "google-datetime",
"type": "string"
},
"githubEnterpriseConfig": {
"description": "The resource name of the GitHubEnterprise to be created. Format: `projects/{project}/locations/{location}/githubEnterpriseConfigs/{id}`.",
"type": "string"
}
},
"type": "object"
},
"RepoSource": {
"description": "Location of the source in a Google Cloud Source Repository.",
"id": "RepoSource",
@@ -1152,6 +1671,50 @@
},
"type": "object"
},
"RunWorkflowCustomOperationMetadata": {
"description": "Represents the custom metadata of the RunWorkflow long-running operation.",
"id": "RunWorkflowCustomOperationMetadata",
"properties": {
"apiVersion": {
"description": "Output only. API version used to start the operation.",
"readOnly": true,
"type": "string"
},
"createTime": {
"description": "Output only. The time the operation was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"endTime": {
"description": "Output only. The time the operation finished running.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"pipelineRunId": {
"description": "Output only. ID of the pipeline run created by RunWorkflow.",
"readOnly": true,
"type": "string"
},
"requestedCancellation": {
"description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.",
"readOnly": true,
"type": "boolean"
},
"target": {
"description": "Output only. Server-defined resource path for the target of the operation.",
"readOnly": true,
"type": "string"
},
"verb": {
"description": "Output only. Name of the verb executed by the operation.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"SMTPDelivery": {
"description": "SMTPDelivery is the delivery configuration for an SMTP (email) notification.",
"id": "SMTPDelivery",
@@ -1266,7 +1829,7 @@
},
"storageSourceManifest": {
"$ref": "StorageSourceManifest",
"description": "If provided, get the source from this manifest in Google Cloud Storage. This feature is in Preview."
"description": "If provided, get the source from this manifest in Google Cloud Storage. This feature is in Preview; see description [here](https://github.com/GoogleCloudPlatform/cloud-builders/tree/master/gcs-fetcher)."
}
},
"type": "object"
@@ -1339,14 +1902,14 @@
"type": "string"
},
"object": {
"description": "Google Cloud Storage object containing the source. This object must be a gzipped archive file (`.tar.gz`) containing source to build.",
"description": "Google Cloud Storage object containing the source. This object must be a zipped (`.zip`) or gzipped archive file (`.tar.gz`) containing source to build.",
"type": "string"
}
},
"type": "object"
},
"StorageSourceManifest": {
"description": "Location of the source manifest in Google Cloud Storage. This feature is in Preview.",
"description": "Location of the source manifest in Google Cloud Storage. This feature is in Preview; see description [here](https://github.com/GoogleCloudPlatform/cloud-builders/tree/master/gcs-fetcher).",
"id": "StorageSourceManifest",
"properties": {
"bucket": {
@@ -1382,6 +1945,90 @@
},
"type": "object"
},
"UpdateBitbucketServerConfigOperationMetadata": {
"description": "Metadata for `UpdateBitbucketServerConfig` operation.",
"id": "UpdateBitbucketServerConfigOperationMetadata",
"properties": {
"bitbucketServerConfig": {
"description": "The resource name of the BitbucketServerConfig to be updated. Format: `projects/{project}/locations/{location}/bitbucketServerConfigs/{id}`.",
"type": "string"
},
"completeTime": {
"description": "Time the operation was completed.",
"format": "google-datetime",
"type": "string"
},
"createTime": {
"description": "Time the operation was created.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"UpdateGitHubEnterpriseConfigOperationMetadata": {
"description": "Metadata for `UpdateGitHubEnterpriseConfig` operation.",
"id": "UpdateGitHubEnterpriseConfigOperationMetadata",
"properties": {
"completeTime": {
"description": "Time the operation was completed.",
"format": "google-datetime",
"type": "string"
},
"createTime": {
"description": "Time the operation was created.",
"format": "google-datetime",
"type": "string"
},
"githubEnterpriseConfig": {
"description": "The resource name of the GitHubEnterprise to be updated. Format: `projects/{project}/locations/{location}/githubEnterpriseConfigs/{id}`.",
"type": "string"
}
},
"type": "object"
},
"UpdateGitLabConfigOperationMetadata": {
"description": "Metadata for `UpdateGitLabConfig` operation.",
"id": "UpdateGitLabConfigOperationMetadata",
"properties": {
"completeTime": {
"description": "Time the operation was completed.",
"format": "google-datetime",
"type": "string"
},
"createTime": {
"description": "Time the operation was created.",
"format": "google-datetime",
"type": "string"
},
"gitlabConfig": {
"description": "The resource name of the GitLabConfig to be created. Format: `projects/{project}/locations/{location}/gitlabConfigs/{id}`.",
"type": "string"
}
},
"type": "object"
},
"UpdateWorkerPoolOperationMetadata": {
"description": "Metadata for the `UpdateWorkerPool` operation.",
"id": "UpdateWorkerPoolOperationMetadata",
"properties": {
"completeTime": {
"description": "Time the operation was completed.",
"format": "google-datetime",
"type": "string"
},
"createTime": {
"description": "Time the operation was created.",
"format": "google-datetime",
"type": "string"
},
"workerPool": {
"description": "The resource name of the `WorkerPool` being updated. Format: `projects/{project}/locations/{location}/workerPools/{worker_pool}`.",
"type": "string"
}
},
"type": "object"
},
"Volume": {
"description": "Volume describes a Docker container volume which is mounted into build steps in order to persist files across build step execution.",
"id": "Volume",
@@ -1397,6 +2044,33 @@
},
"type": "object"
},
"Warning": {
"description": "A non-fatal problem encountered during the execution of the build.",
"id": "Warning",
"properties": {
"priority": {
"description": "The priority for this warning.",
"enum": [
"PRIORITY_UNSPECIFIED",
"INFO",
"WARNING",
"ALERT"
],
"enumDescriptions": [
"Should not be used.",
"e.g. deprecation warnings and alternative feature highlights.",
"e.g. automated detection of possible issues with the build.",
"e.g. alerts that a feature used in the build is pending removal"
],
"type": "string"
},
"text": {
"description": "Explanation of the warning generated.",
"type": "string"
}
},
"type": "object"
},
"WorkerConfig": {
"description": "Defines the configuration to be used for creating workers in the pool.",
"id": "WorkerConfig",
@@ -1421,6 +2095,13 @@
"description": "Configuration for a `WorkerPool` to run the builds. Workers provide a build environment where Cloud Build runs your builds. Cloud Build owns and maintains a pool of workers for general use. By default, when you submit a build, Cloud Build uses one of the workers from this pool. Builds that run in the default worker pool have access to the public internet. If your build needs access to resources on a private network, create and use a `WorkerPool` to run your builds. Custom `WorkerPool`s give your builds access to any single VPC network that you administer, including any on-prem resources connected to that VPC network. For an overview of custom worker pools, see [Custom workers overview](https://cloud.google.com/cloud-build/docs/custom-workers/custom-workers-overview).",
"id": "WorkerPool",
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "User specified annotations. See https://google.aip.dev/128#annotations for more details such as format and size limitations.",
"type": "object"
},
"createTime": {
"description": "Output only. Time at which the request to create the `WorkerPool` was received.",
"format": "google-datetime",
@@ -1433,6 +2114,15 @@
"readOnly": true,
"type": "string"
},
"displayName": {
"description": "A user-specified, human-readable name for the `WorkerPool`. If provided, this value must be 1-63 characters.",
"type": "string"
},
"etag": {
"description": "Output only. Checksum computed by the server. May be sent on update and delete requests to ensure that the client has an up-to-date value before proceeding.",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Output only. The resource name of the `WorkerPool`, with format `projects/{project}/locations/{location}/workerPools/{worker_pool}`. The value of `{worker_pool}` is provided by `worker_pool_id` in `CreateWorkerPool` request and the value of `{location}` is determined by the endpoint accessed.",
"readOnly": true,
@@ -1461,6 +2151,11 @@
"readOnly": true,
"type": "string"
},
"uid": {
"description": "Output only. A unique identifier for the `WorkerPool`.",
"readOnly": true,
"type": "string"
},
"updateTime": {
"description": "Output only. Time at which the request to update the `WorkerPool` was received.",
"format": "google-datetime",

234
etc/api/cloudchannel/v1/cloudchannel-api.json
View File

@@ -12,7 +12,7 @@
"baseUrl": "https://cloudchannel.googleapis.com/",
"batchPath": "batch",
"canonicalName": "Cloudchannel",
"description": "",
"description": "The Cloud Channel API enables Google Cloud partners to have a single unified resale platform and APIs across all of Google Cloud including GCP, Workspace, Maps and Chrome.",
"discoveryVersion": "v1",
"documentationLink": "https://cloud.google.com/channel",
"fullyEncodeReservedExpansion": true,
@@ -316,7 +316,7 @@
]
},
"get": {
"description": "Returns a requested ChannelPartnerLink resource. You must be a distributor to call this method. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: ChannelPartnerLink resource not found because of an invalid channel partner link name. Return value: The ChannelPartnerLink resource.",
"description": "Returns the requested ChannelPartnerLink resource. You must be a distributor to call this method. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: ChannelPartnerLink resource not found because of an invalid channel partner link name. Return value: The ChannelPartnerLink resource.",
"flatPath": "v1/accounts/{accountsId}/channelPartnerLinks/{channelPartnerLinksId}",
"httpMethod": "GET",
"id": "cloudchannel.accounts.channelPartnerLinks.get",
@@ -467,7 +467,7 @@
]
},
"delete": {
"description": "Deletes the given Customer permanently and irreversibly. Possible error codes: * PERMISSION_DENIED: The account making the request does not own this customer. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * FAILED_PRECONDITION: The customer has existing entitlements. * NOT_FOUND: No Customer resource found for the name in the request.",
"description": "Deletes the given Customer permanently. Possible error codes: * PERMISSION_DENIED: The account making the request does not own this customer. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * FAILED_PRECONDITION: The customer has existing entitlements. * NOT_FOUND: No Customer resource found for the name in the request.",
"flatPath": "v1/accounts/{accountsId}/channelPartnerLinks/{channelPartnerLinksId}/customers/{customersId}",
"httpMethod": "DELETE",
"id": "cloudchannel.accounts.channelPartnerLinks.customers.delete",
@@ -492,7 +492,7 @@
]
},
"get": {
"description": "Returns a requested Customer resource. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The customer resource doesn't exist. Usually the result of an invalid name parameter. Return value: The Customer resource.",
"description": "Returns the requested Customer resource. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The customer resource doesn't exist. Usually the result of an invalid name parameter. Return value: The Customer resource.",
"flatPath": "v1/accounts/{accountsId}/channelPartnerLinks/{channelPartnerLinksId}/customers/{customersId}",
"httpMethod": "GET",
"id": "cloudchannel.accounts.channelPartnerLinks.customers.get",
@@ -516,6 +516,34 @@
"https://www.googleapis.com/auth/apps.order"
]
},
"import": {
"description": "Imports a Customer from the Cloud Identity associated with the provided Cloud Identity ID or domain before a TransferEntitlements call. If a linked Customer already exists and overwrite_if_exists is true, it will update that Customer's data. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * NOT_FOUND: Cloud Identity doesn't exist or was deleted. * INVALID_ARGUMENT: Required parameters are missing, or the auth_token is expired or invalid. * ALREADY_EXISTS: A customer already exists and has conflicting critical fields. Requires an overwrite. Return value: The Customer.",
"flatPath": "v1/accounts/{accountsId}/channelPartnerLinks/{channelPartnerLinksId}/customers:import",
"httpMethod": "POST",
"id": "cloudchannel.accounts.channelPartnerLinks.customers.import",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The resource name of the reseller's account. Parent takes the format: accounts/{account_id} or accounts/{account_id}/channelPartnerLinks/{channel_partner_id}",
"location": "path",
"pattern": "^accounts/[^/]+/channelPartnerLinks/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/customers:import",
"request": {
"$ref": "GoogleCloudChannelV1ImportCustomerRequest"
},
"response": {
"$ref": "GoogleCloudChannelV1Customer"
},
"scopes": [
"https://www.googleapis.com/auth/apps.order"
]
},
"list": {
"description": "List Customers. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * INVALID_ARGUMENT: Required request parameters are missing or invalid. Return value: List of Customers, or an empty list if there are no customers.",
"flatPath": "v1/accounts/{accountsId}/channelPartnerLinks/{channelPartnerLinksId}/customers",
@@ -525,6 +553,11 @@
"parent"
],
"parameters": {
"filter": {
"description": "Optional. Filters applied to the [CloudChannelService.ListCustomers] results. See https://cloud.google.com/channel/docs/concepts/google-cloud/filter-customers for more information.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Optional. The maximum number of customers to return. The service may return fewer than this value. If unspecified, returns at most 10 customers. The maximum value is 50.",
"format": "int32",
@@ -621,7 +654,7 @@
]
},
"delete": {
"description": "Deletes the given Customer permanently and irreversibly. Possible error codes: * PERMISSION_DENIED: The account making the request does not own this customer. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * FAILED_PRECONDITION: The customer has existing entitlements. * NOT_FOUND: No Customer resource found for the name in the request.",
"description": "Deletes the given Customer permanently. Possible error codes: * PERMISSION_DENIED: The account making the request does not own this customer. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * FAILED_PRECONDITION: The customer has existing entitlements. * NOT_FOUND: No Customer resource found for the name in the request.",
"flatPath": "v1/accounts/{accountsId}/customers/{customersId}",
"httpMethod": "DELETE",
"id": "cloudchannel.accounts.customers.delete",
@@ -646,7 +679,7 @@
]
},
"get": {
"description": "Returns a requested Customer resource. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The customer resource doesn't exist. Usually the result of an invalid name parameter. Return value: The Customer resource.",
"description": "Returns the requested Customer resource. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The customer resource doesn't exist. Usually the result of an invalid name parameter. Return value: The Customer resource.",
"flatPath": "v1/accounts/{accountsId}/customers/{customersId}",
"httpMethod": "GET",
"id": "cloudchannel.accounts.customers.get",
@@ -670,6 +703,34 @@
"https://www.googleapis.com/auth/apps.order"
]
},
"import": {
"description": "Imports a Customer from the Cloud Identity associated with the provided Cloud Identity ID or domain before a TransferEntitlements call. If a linked Customer already exists and overwrite_if_exists is true, it will update that Customer's data. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * NOT_FOUND: Cloud Identity doesn't exist or was deleted. * INVALID_ARGUMENT: Required parameters are missing, or the auth_token is expired or invalid. * ALREADY_EXISTS: A customer already exists and has conflicting critical fields. Requires an overwrite. Return value: The Customer.",
"flatPath": "v1/accounts/{accountsId}/customers:import",
"httpMethod": "POST",
"id": "cloudchannel.accounts.customers.import",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The resource name of the reseller's account. Parent takes the format: accounts/{account_id} or accounts/{account_id}/channelPartnerLinks/{channel_partner_id}",
"location": "path",
"pattern": "^accounts/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/customers:import",
"request": {
"$ref": "GoogleCloudChannelV1ImportCustomerRequest"
},
"response": {
"$ref": "GoogleCloudChannelV1Customer"
},
"scopes": [
"https://www.googleapis.com/auth/apps.order"
]
},
"list": {
"description": "List Customers. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * INVALID_ARGUMENT: Required request parameters are missing or invalid. Return value: List of Customers, or an empty list if there are no customers.",
"flatPath": "v1/accounts/{accountsId}/customers",
@@ -679,6 +740,11 @@
"parent"
],
"parameters": {
"filter": {
"description": "Optional. Filters applied to the [CloudChannelService.ListCustomers] results. See https://cloud.google.com/channel/docs/concepts/google-cloud/filter-customers for more information.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Optional. The maximum number of customers to return. The service may return fewer than this value. If unspecified, returns at most 10 customers. The maximum value is 50.",
"format": "int32",
@@ -1119,7 +1185,7 @@
]
},
"get": {
"description": "Returns a requested Entitlement resource. Possible error codes: * PERMISSION_DENIED: The customer doesn't belong to the reseller. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The customer entitlement was not found. Return value: The requested Entitlement resource.",
"description": "Returns the requested Entitlement resource. Possible error codes: * PERMISSION_DENIED: The customer doesn't belong to the reseller. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The customer entitlement was not found. Return value: The requested Entitlement resource.",
"flatPath": "v1/accounts/{accountsId}/customers/{customersId}/entitlements/{entitlementsId}",
"httpMethod": "GET",
"id": "cloudchannel.accounts.customers.entitlements.get",
@@ -1179,6 +1245,31 @@
"https://www.googleapis.com/auth/apps.order"
]
},
"lookupOffer": {
"description": "Returns the requested Offer resource. Possible error codes: * PERMISSION_DENIED: The entitlement doesn't belong to the reseller. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: Entitlement or offer was not found. Return value: The Offer resource.",
"flatPath": "v1/accounts/{accountsId}/customers/{customersId}/entitlements/{entitlementsId}:lookupOffer",
"httpMethod": "GET",
"id": "cloudchannel.accounts.customers.entitlements.lookupOffer",
"parameterOrder": [
"entitlement"
],
"parameters": {
"entitlement": {
"description": "Required. The resource name of the entitlement to retrieve the Offer. Entitlement uses the format: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}",
"location": "path",
"pattern": "^accounts/[^/]+/customers/[^/]+/entitlements/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+entitlement}:lookupOffer",
"response": {
"$ref": "GoogleCloudChannelV1Offer"
},
"scopes": [
"https://www.googleapis.com/auth/apps.order"
]
},
"startPaidService": {
"description": "Starts paid service for a trial entitlement. Starts paid service for a trial entitlement immediately. This method is only applicable if a plan is set up for a trial entitlement but has some trial days remaining. Possible error codes: * PERMISSION_DENIED: The customer doesn't belong to the reseller. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: Entitlement resource not found. * FAILED_PRECONDITION/NOT_IN_TRIAL: This method only works for entitlement on trial plans. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The ID of a long-running operation. To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of OperationMetadata.",
"flatPath": "v1/accounts/{accountsId}/customers/{customersId}/entitlements/{entitlementsId}:startPaidService",
@@ -1508,7 +1599,7 @@
}
}
},
"revision": "20210326",
"revision": "20220303",
"rootUrl": "https://cloudchannel.googleapis.com/",
"schemas": {
"GoogleCloudChannelV1ActivateEntitlementRequest": {
@@ -1572,7 +1663,7 @@
"type": "string"
},
"parameters": {
"description": "Optional. Parameters needed to purchase the Offer.",
"description": "Optional. Parameters needed to purchase the Offer. To view the available Parameters refer to the Offer.parameter_definitions from the desired offer.",
"items": {
"$ref": "GoogleCloudChannelV1Parameter"
},
@@ -1594,7 +1685,7 @@
"id": "GoogleCloudChannelV1ChangeParametersRequest",
"properties": {
"parameters": {
"description": "Required. Entitlement parameters to update. You can only change editable parameters.",
"description": "Required. Entitlement parameters to update. You can only change editable parameters. To view the available Parameters for a request, refer to the Offer.parameter_definitions from the desired offer.",
"items": {
"$ref": "GoogleCloudChannelV1Parameter"
},
@@ -1656,7 +1747,7 @@
"SUSPENDED"
],
"enumDescriptions": [
"The state is not specified.",
"Not used.",
"An invitation has been sent to the reseller to create a channel partner link.",
"Status when the reseller is active.",
"Status when the reseller has been revoked by the distributor.",
@@ -1756,7 +1847,7 @@
"TEAM"
],
"enumDescriptions": [
"Default value. This state doesn't show unless an error occurs.",
"Not used.",
"Domain-owning customer which needs domain verification to use services.",
"Team customer which needs email verification to use services."
],
@@ -1826,28 +1917,28 @@
"id": "GoogleCloudChannelV1ContactInfo",
"properties": {
"displayName": {
"description": "Output only. Display name of the contact in the customer account. Populated by combining customer first name and last name.",
"description": "Output only. The customer account contact's display name, formatted as a combination of the customer's first and last name.",
"readOnly": true,
"type": "string"
},
"email": {
"description": "Email of the contact in the customer account. Email is required for entitlements that need creation of admin.google.com accounts. The email will be the username used in credentials to access the admin.google.com account.",
"description": "The customer account's contact email. Required for entitlements that create admin.google.com accounts, and serves as the customer's username for those accounts. Use this email to invite Team customers.",
"type": "string"
},
"firstName": {
"description": "First name of the contact in the customer account.",
"description": "The customer account contact's first name. Optional for Team customers.",
"type": "string"
},
"lastName": {
"description": "Last name of the contact in the customer account.",
"description": "The customer account contact's last name. Optional for Team customers.",
"type": "string"
},
"phone": {
"description": "Phone number of the contact in the customer account.",
"description": "The customer account's contact phone number.",
"type": "string"
},
"title": {
"description": "Optional. Job title of the contact in the customer account.",
"description": "Optional. The customer account contact's job title.",
"type": "string"
}
},
@@ -1873,7 +1964,7 @@
"id": "GoogleCloudChannelV1Customer",
"properties": {
"alternateEmail": {
"description": "Secondary contact email. Alternate email and primary contact email are required to have different domains if primary contact email is present. When creating admin.google.com accounts, users get notified credentials at this email. This email address is also used as a recovery email.",
"description": "Secondary contact email. You need to provide an alternate email to create different domains if a primary contact email already exists. Users will receive a notification with credentials when you create an admin.google.com account. Secondary emails are also recovery email addresses. Alternate emails are optional when you create Team customers.",
"type": "string"
},
"channelPartnerId": {
@@ -1881,7 +1972,7 @@
"type": "string"
},
"cloudIdentityId": {
"description": "Output only. Customer's cloud_identity_id. Populated only if a Cloud Identity resource exists for this customer.",
"description": "Output only. The customer's Cloud Identity ID if the customer has a Cloud Identity resource.",
"readOnly": true,
"type": "string"
},
@@ -1891,13 +1982,13 @@
"readOnly": true
},
"createTime": {
"description": "Output only. The time at which the customer is created.",
"description": "Output only. Time when the customer was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"domain": {
"description": "Required. Primary domain used by the customer. Domain of primary contact email is required to be same as the provided domain.",
"description": "Required. The customer's primary domain. Must match the primary contact email's domain.",
"type": "string"
},
"languageCode": {
@@ -1915,14 +2006,14 @@
},
"orgPostalAddress": {
"$ref": "GoogleTypePostalAddress",
"description": "Required. Address of the organization of the customer entity. Region and zip codes are required to enforce US laws and embargoes. Valid address lines are required for all customers. Language code is discarded. Use the Customer-level language code to set the customer's language."
"description": "Required. The organization address for the customer. To enforce US laws and embargoes, we require a region and zip code. You must provide valid addresses for every customer. To set the customer's language, use the Customer-level language code."
},
"primaryContactInfo": {
"$ref": "GoogleCloudChannelV1ContactInfo",
"description": "Primary contact info."
},
"updateTime": {
"description": "Output only. The time at which the customer is updated.",
"description": "Output only. Time when the customer was updated.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
@@ -1943,7 +2034,7 @@
"TEAM"
],
"enumDescriptions": [
"Default value. This state doesn't show unless an error occurs.",
"Not used.",
"Domain-owning customer which needs domain verification to use services.",
"Team customer which needs email verification to use services."
],
@@ -1996,7 +2087,7 @@
"PRIMARY_DOMAIN_VERIFIED"
],
"enumDescriptions": [
"Default value. This state doesn't show unless an error occurs.",
"Not used.",
"Primary domain for customer was changed.",
"Primary domain of the customer has been verified."
],
@@ -2022,7 +2113,7 @@
"SIZE_10001_OR_MORE"
],
"enumDescriptions": [
"Default value. This state doesn't show unless an error occurs.",
"Not used.",
"1 - 100",
"101 - 500",
"501 - 1,000",
@@ -2041,7 +2132,7 @@
"UNIVERSITY"
],
"enumDescriptions": [
"Default value. This state doesn't show unless an error occurs.",
"Not used.",
"Elementary/Secondary Schools & Districts",
"Higher Education Universities & Colleges"
],
@@ -2082,7 +2173,7 @@
"type": "string"
},
"parameters": {
"description": "Extended entitlement parameters. When creating an entitlement, valid parameters' names and values are defined in the offer's parameter definitions.",
"description": "Extended entitlement parameters. When creating an entitlement, valid parameter names and values are defined in the Offer.parameter_definitions. The response may include the following output-only Parameters: - assigned_units: The number of licenses assigned to users. - max_units: The maximum assignable units for a flexible offer. - num_units: The total commitment for commitment-based offers.",
"items": {
"$ref": "GoogleCloudChannelV1Parameter"
},
@@ -2101,7 +2192,7 @@
"SUSPENDED"
],
"enumDescriptions": [
"Default value. This state doesn't show unless an error occurs.",
"Not used.",
"The entitlement is currently active.",
"The entitlement is currently suspended."
],
@@ -2124,7 +2215,7 @@
"OTHER"
],
"enumDescriptions": [
"Default value. This state doesn't show unless an error occurs.",
"Not used.",
"Entitlement was manually suspended by the Reseller.",
"Trial ended.",
"Entitlement renewal was canceled.",
@@ -2172,10 +2263,11 @@
"SKU_CHANGED",
"RENEWAL_SETTING_CHANGED",
"PAID_SERVICE_STARTED",
"LICENSE_ASSIGNMENT_CHANGED"
"LICENSE_ASSIGNMENT_CHANGED",
"LICENSE_CAP_CHANGED"
],
"enumDescriptions": [
"Default value. This state doesn't show unless an error occurs.",
"Not used.",
"A new entitlement was created.",
"The offer type associated with an entitlement was changed. This is not triggered if an entitlement converts from a commit offer to a flexible offer as part of a renewal.",
"Annual commitment for a commit plan was changed.",
@@ -2186,13 +2278,45 @@
"Entitlement was upgraded or downgraded (e.g. from Google Workspace Business Standard to Google Workspace Business Plus).",
"The renewal settings of an entitlement has changed.",
"Paid service has started on trial entitlement.",
"License was assigned to or revoked from a user."
"License was assigned to or revoked from a user.",
"License cap was changed for the entitlement."
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudChannelV1ImportCustomerRequest": {
"description": "Request message for CloudChannelService.ImportCustomer",
"id": "GoogleCloudChannelV1ImportCustomerRequest",
"properties": {
"authToken": {
"description": "Optional. The super admin of the resold customer generates this token to authorize a reseller to access their Cloud Identity and purchase entitlements on their behalf. You can omit this token after authorization. See https://support.google.com/a/answer/7643790 for more details.",
"type": "string"
},
"channelPartnerId": {
"description": "Optional. Cloud Identity ID of a channel partner who will be the direct reseller for the customer's order. This field is required for 2-tier transfer scenarios and can be provided via the request Parent binding as well.",
"type": "string"
},
"cloudIdentityId": {
"description": "Required. Customer's Cloud Identity ID",
"type": "string"
},
"customer": {
"description": "Optional. Specifies the customer that will receive imported Cloud Identity information. Format: accounts/{account_id}/customers/{customer_id}",
"type": "string"
},
"domain": {
"description": "Required. Customer domain.",
"type": "string"
},
"overwriteIfExists": {
"description": "Required. Choose to overwrite an existing customer if found. This must be set to true if there is an existing customer with a conflicting region code or domain.",
"type": "boolean"
}
},
"type": "object"
},
"GoogleCloudChannelV1ListChannelPartnerLinksResponse": {
"description": "Response message for CloudChannelService.ListChannelPartnerLinks.",
"id": "GoogleCloudChannelV1ListChannelPartnerLinksResponse",
@@ -2578,7 +2702,7 @@
"PROVISION_CLOUD_IDENTITY"
],
"enumDescriptions": [
"Default value. This state doesn't show unless an error occurs.",
"Not used.",
"Long Running Operation was triggered by CreateEntitlement.",
"Long Running Operation was triggered by ChangeRenewalSettings.",
"Long Running Operation was triggered by StartPaidService.",
@@ -2918,7 +3042,7 @@
"type": "string"
},
"provisioningId": {
"description": "Output only. Provisioning ID of the entitlement. For Google Workspace, this would be the underlying Subscription ID.",
"description": "Output only. Provisioning ID of the entitlement. For Google Workspace, this is the underlying Subscription ID. For Google Cloud Platform, this is the Billing Account ID of the billing subaccount.\"",
"readOnly": true,
"type": "string"
},
@@ -3044,16 +3168,16 @@
"type": "object"
},
"GoogleCloudChannelV1SubscriberEvent": {
"description": "Represents information which resellers will get as part of notification from Cloud Pub/Sub.",
"description": "Represents information which resellers will get as part of notification from Pub/Sub.",
"id": "GoogleCloudChannelV1SubscriberEvent",
"properties": {
"customerEvent": {
"$ref": "GoogleCloudChannelV1CustomerEvent",
"description": "Customer event send as part of Pub/Sub event to partners."
"description": "Customer event sent as part of Pub/Sub event to partners."
},
"entitlementEvent": {
"$ref": "GoogleCloudChannelV1EntitlementEvent",
"description": "Entitlement event send as part of Pub/Sub event to partners."
"description": "Entitlement event sent as part of Pub/Sub event to partners."
}
},
"type": "object"
@@ -3086,7 +3210,7 @@
"SKU_SUSPENDED"
],
"enumDescriptions": [
"Reason is not available.",
"Not used.",
"Reseller needs to accept TOS before transferring the SKU.",
"Reseller not eligible to sell the SKU.",
"SKU subscription is suspended"
@@ -3321,7 +3445,7 @@
"PRIMARY_DOMAIN_VERIFIED"
],
"enumDescriptions": [
"Default value. This state doesn't show unless an error occurs.",
"Not used.",
"Primary domain for customer was changed.",
"Primary domain of the customer has been verified."
],
@@ -3377,7 +3501,7 @@
"type": "string"
},
"parameters": {
"description": "Extended entitlement parameters. When creating an entitlement, valid parameters' names and values are defined in the offer's parameter definitions.",
"description": "Extended entitlement parameters. When creating an entitlement, valid parameter names and values are defined in the Offer.parameter_definitions. The response may include the following output-only Parameters: - assigned_units: The number of licenses assigned to users. - max_units: The maximum assignable units for a flexible offer. - num_units: The total commitment for commitment-based offers.",
"items": {
"$ref": "GoogleCloudChannelV1alpha1Parameter"
},
@@ -3399,7 +3523,7 @@
"SUSPENDED"
],
"enumDescriptions": [
"Default value. This state doesn't show unless an error occurs.",
"Not used.",
"The entitlement is currently active.",
"The entitlement was canceled. After an entitlement is `CANCELED`, its status will not change. Deprecated: Canceled entitlements will no longer be visible.",
"The entitlement reached end of term and was not renewed. After an entitlement is `COMPLETE`, its status will not change. Deprecated: This is represented as ProvisioningState=SUSPENDED and suspensionReason in (TRIAL_ENDED, RENEWAL_WITH_TYPE_CANCEL)",
@@ -3425,7 +3549,7 @@
"OTHER"
],
"enumDescriptions": [
"Default value. This state doesn't show unless an error occurs.",
"Not used.",
"Entitlement was manually suspended by the Reseller.",
"Trial ended.",
"Entitlement renewal was canceled.",
@@ -3473,10 +3597,11 @@
"SKU_CHANGED",
"RENEWAL_SETTING_CHANGED",
"PAID_SERVICE_STARTED",
"LICENSE_ASSIGNMENT_CHANGED"
"LICENSE_ASSIGNMENT_CHANGED",
"LICENSE_CAP_CHANGED"
],
"enumDescriptions": [
"Default value. This state doesn't show unless an error occurs.",
"Not used.",
"A new entitlement was created.",
"The offer type associated with an entitlement was changed. This is not triggered if an entitlement converts from a commit offer to a flexible offer as part of a renewal.",
"Annual commitment for a commit plan was changed.",
@@ -3487,7 +3612,8 @@
"Entitlement was upgraded or downgraded (e.g. from Google Workspace Business Standard to Google Workspace Business Plus).",
"The renewal settings of an entitlement has changed.",
"Paid service has started on trial entitlement.",
"License was assigned to or revoked from a user."
"License was assigned to or revoked from a user.",
"License cap was changed for the entitlement."
],
"type": "string"
}
@@ -3518,7 +3644,7 @@
"PROVISION_CLOUD_IDENTITY"
],
"enumDescriptions": [
"Default value. This state doesn't show unless an error occurs.",
"Not used.",
"Long Running Operation was triggered by CreateEntitlement.",
"Long Running Operation was triggered by ChangeQuantity.",
"Long Running Operation was triggered by ChangeRenewalSettings.",
@@ -3597,7 +3723,7 @@
"type": "string"
},
"provisioningId": {
"description": "Output only. Provisioning ID of the entitlement. For Google Workspace, this would be the underlying Subscription ID.",
"description": "Output only. Provisioning ID of the entitlement. For Google Workspace, this is the underlying Subscription ID. For Google Cloud Platform, this is the Billing Account ID of the billing subaccount.\"",
"readOnly": true,
"type": "string"
},
@@ -3633,7 +3759,7 @@
"MONTHLY"
],
"enumDescriptions": [
"Default value. This state doesn't show unless an error occurs.",
"Not used.",
"Paid in yearly installments.",
"Paid in monthly installments."
],
@@ -3667,16 +3793,16 @@
"type": "object"
},
"GoogleCloudChannelV1alpha1SubscriberEvent": {
"description": "Represents information which resellers will get as part of notification from Cloud Pub/Sub.",
"description": "Represents information which resellers will get as part of notification from Pub/Sub.",
"id": "GoogleCloudChannelV1alpha1SubscriberEvent",
"properties": {
"customerEvent": {
"$ref": "GoogleCloudChannelV1alpha1CustomerEvent",
"description": "Customer event send as part of Pub/Sub event to partners."
"description": "Customer event sent as part of Pub/Sub event to partners."
},
"entitlementEvent": {
"$ref": "GoogleCloudChannelV1alpha1EntitlementEvent",
"description": "Entitlement event send as part of Pub/Sub event to partners."
"description": "Entitlement event sent as part of Pub/Sub event to partners."
}
},
"type": "object"
@@ -3896,7 +4022,7 @@
"type": "array"
},
"regionCode": {
"description": "Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See http://cldr.unicode.org/ and http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: \"CH\" for Switzerland.",
"description": "Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: \"CH\" for Switzerland.",
"type": "string"
},
"revision": {

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

@@ -3,7 +3,7 @@
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "See, edit, configure, and delete your Google Cloud Platform data"
"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
},
"https://www.googleapis.com/auth/cloud_debugger": {
"description": "Use Stackdriver Debugger"
@@ -448,7 +448,7 @@
}
}
},
"revision": "20210326",
"revision": "20220225",
"rootUrl": "https://clouddebugger.googleapis.com/",
"schemas": {
"AliasContext": {

2416
etc/api/clouddeploy/v1/clouddeploy-api.json Normal file
View File

File diff suppressed because it is too large Load Diff

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

@@ -3,7 +3,7 @@
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "See, edit, configure, and delete your Google Cloud Platform data"
"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
}
}
}
@@ -213,7 +213,7 @@
]
},
"report": {
"description": "Report an individual error event and record the event to a log. This endpoint accepts **either** an OAuth token, **or** an [API key](https://support.google.com/cloud/answer/6158862) for authentication. To use an API key, append it to the URL as the value of a `key` parameter. For example: `POST https://clouderrorreporting.googleapis.com/v1beta1/{projectName}/events:report?key=123ABC456` **Note:** [Error Reporting](/error-reporting) is a global service built on Cloud Logging and doesn't analyze logs stored in regional log buckets or logs routed to other Google Cloud projects. For more information, see [Using Error Reporting with regionalized logs](/error-reporting/docs/regionalization).",
"description": "Report an individual error event and record the event to a log. This endpoint accepts **either** an OAuth token, **or** an [API key](https://support.google.com/cloud/answer/6158862) for authentication. To use an API key, append it to the URL as the value of a `key` parameter. For example: `POST https://clouderrorreporting.googleapis.com/v1beta1/{projectName}/events:report?key=123ABC456` **Note:** [Error Reporting] (https://cloud.google.com/error-reporting) is a global service built on Cloud Logging and doesn't analyze logs stored in regional log buckets or logs routed to other Google Cloud projects. For more information, see [Using Error Reporting with regionalized logs] (https://cloud.google.com/error-reporting/docs/regionalization).",
"flatPath": "v1beta1/projects/{projectsId}/events:report",
"httpMethod": "POST",
"id": "clouderrorreporting.projects.events.report",
@@ -430,7 +430,7 @@
}
}
},
"revision": "20210323",
"revision": "20220302",
"rootUrl": "https://clouderrorreporting.googleapis.com/",
"schemas": {
"DeleteEventsResponse": {
@@ -676,7 +676,7 @@
"description": "Optional. A description of the context in which the error occurred."
},
"eventTime": {
"description": "Optional. Time when the event occurred. If not provided, the time when the event was received by the Error Reporting system will be used.",
"description": "Optional. Time when the event occurred. If not provided, the time when the event was received by the Error Reporting system is used. If provided, the time must not exceed the [logs retention period](https://cloud.google.com/logging/quotas#logs_retention_periods) in the past, or be more than 24 hours in the future. If an invalid time is provided, then an error is returned.",
"format": "google-datetime",
"type": "string"
},

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

@@ -3,7 +3,7 @@
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "See, edit, configure, and delete your Google Cloud Platform data"
"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
}
}
}
@@ -197,7 +197,7 @@
"type": "string"
},
"pageSize": {
"description": "The maximum number of results to return. If not set, the service will select a default.",
"description": "The maximum number of results to return. If not set, the service selects a default.",
"format": "int32",
"location": "query",
"type": "integer"
@@ -392,7 +392,7 @@
],
"parameters": {
"options.requestedPolicyVersion": {
"description": "Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
"format": "int32",
"location": "query",
"type": "integer"
@@ -466,7 +466,7 @@
"type": "string"
},
"updateMask": {
"description": "Required list of fields to be updated in this request.",
"description": "Required. The list of fields in `CloudFunction` that have to be updated.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
@@ -546,7 +546,7 @@
}
}
},
"revision": "20210325",
"revision": "20220224",
"rootUrl": "https://cloudfunctions.googleapis.com/",
"schemas": {
"AuditConfig": {
@@ -598,22 +598,22 @@
"type": "object"
},
"Binding": {
"description": "Associates `members` with a `role`.",
"description": "Associates `members`, or principals, with a `role`.",
"id": "Binding",
"properties": {
"condition": {
"$ref": "Expr",
"description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)."
"description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)."
},
"members": {
"description": "Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ",
"description": "Specifies the principals requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ",
"items": {
"type": "string"
},
"type": "array"
},
"role": {
"description": "Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.",
"description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.",
"type": "string"
}
},
@@ -670,14 +670,37 @@
"readOnly": true,
"type": "string"
},
"buildName": {
"description": "Output only. The Cloud Build Name of the function deployment. `projects//locations//builds/`.",
"readOnly": true,
"type": "string"
},
"buildWorkerPool": {
"description": "Name of the Cloud Build Custom Worker Pool that should be used to build the function. The format of this field is `projects/{project}/locations/{region}/workerPools/{workerPool}` where {project} and {region} are the project id and region respectively where the worker pool is defined and {workerPool} is the short name of the worker pool. If the project id is not the same as the function, then the Cloud Functions Service Agent (service-@gcf-admin-robot.iam.gserviceaccount.com) must be granted the role Cloud Build Custom Workers Builder (roles/cloudbuild.customworkers.builder) in the project.",
"description": "Name of the Cloud Build Custom Worker Pool that should be used to build the function. The format of this field is `projects/{project}/locations/{region}/workerPools/{workerPool}` where `{project}` and `{region}` are the project id and region respectively where the worker pool is defined and `{workerPool}` is the short name of the worker pool. If the project id is not the same as the function, then the Cloud Functions Service Agent (`service-@gcf-admin-robot.iam.gserviceaccount.com`) must be granted the role Cloud Build Custom Workers Builder (`roles/cloudbuild.customworkers.builder`) in the project.",
"type": "string"
},
"description": {
"description": "User-provided description of a function.",
"type": "string"
},
"dockerRegistry": {
"description": "Docker Registry to use for this deployment. If `docker_repository` field is specified, this field will be automatically set as `ARTIFACT_REGISTRY`. If unspecified, it currently defaults to `CONTAINER_REGISTRY`. This field may be overridden by the backend for eligible deployments.",
"enum": [
"DOCKER_REGISTRY_UNSPECIFIED",
"CONTAINER_REGISTRY",
"ARTIFACT_REGISTRY"
],
"enumDescriptions": [
"Unspecified.",
"Docker images will be stored in multi-regional Container Registry repositories named `gcf`.",
"Docker images will be stored in regional Artifact Registry repositories. By default, GCF will create and use repositories named `gcf-artifacts` in every region in which a function is deployed. But the repository to use can also be specified by the user using the `docker_repository` field."
],
"type": "string"
},
"dockerRepository": {
"description": "User managed repository created in Artifact Registry optionally with a customer managed encryption key. If specified, deployments will use Artifact Registry. If unspecified and the deployment is eligible to use Artifact Registry, GCF will create and use a repository named 'gcf-artifacts' for every deployed region. This is the repository to which the function docker image will be pushed after it is built by Cloud Build. It must match the pattern `projects/{project}/locations/{location}/repositories/{repository}`. Cross-project repositories are not supported. Cross-location repositories are not supported. Repository format must be 'DOCKER'.",
"type": "string"
},
"entryPoint": {
"description": "The name of the function (as defined in source code) that will be executed. Defaults to the resource name suffix, if not specified. For backward compatibility, if function with given name is not found, then the system will try to use function named \"function\". For Node.js this is name of a function exported by the module specified in `source_location`.",
"type": "string"
@@ -713,6 +736,10 @@
],
"type": "string"
},
"kmsKeyName": {
"description": "Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt function resources. It must match the pattern `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`. If specified, you must also provide an artifact registry repository using the `docker_repository` field that was created with the same KMS crypto key. The following service accounts need to be granted the role 'Cloud KMS CryptoKey Encrypter/Decrypter (roles/cloudkms.cryptoKeyEncrypterDecrypter)' on the Key/KeyRing/Project/Organization (least access preferred). 1. Google Cloud Functions service account (service-{project_number}@gcf-admin-robot.iam.gserviceaccount.com) - Required to protect the function's image. 2. Google Storage service account (service-{project_number}@gs-project-accounts.iam.gserviceaccount.com) - Required to protect the function's source code. If this service account does not exist, deploying a function without a KMS key or retrieving the service agent name provisions it. For more information, see https://cloud.google.com/storage/docs/projects#service-agents and https://cloud.google.com/storage/docs/getting-service-agent#gsutil. Google Cloud Functions delegates access to service agents to protect function resources in internal projects that are not accessible by the end user.",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
@@ -725,24 +752,43 @@
"format": "int32",
"type": "integer"
},
"minInstances": {
"description": "A lower bound for the number function instances that may coexist at a given time.",
"format": "int32",
"type": "integer"
},
"name": {
"description": "A user-defined name of the function. Function names must be unique globally and match pattern `projects/*/locations/*/functions/*`",
"type": "string"
},
"network": {
"description": "The VPC Network that this cloud function can connect to. It can be either the fully-qualified URI, or the short name of the network resource. If the short network name is used, the network must belong to the same project. Otherwise, it must belong to a project within the same organization. The format of this field is either `projects/{project}/global/networks/{network}` or `{network}`, where {project} is a project id where the network is defined, and {network} is the short name of the network. This field is mutually exclusive with `vpc_connector` and will be replaced by it. See [the VPC documentation](https://cloud.google.com/compute/docs/vpc) for more information on connecting Cloud projects.",
"description": "The VPC Network that this cloud function can connect to. It can be either the fully-qualified URI, or the short name of the network resource. If the short network name is used, the network must belong to the same project. Otherwise, it must belong to a project within the same organization. The format of this field is either `projects/{project}/global/networks/{network}` or `{network}`, where `{project}` is a project id where the network is defined, and `{network}` is the short name of the network. This field is mutually exclusive with `vpc_connector` and will be replaced by it. See [the VPC documentation](https://cloud.google.com/compute/docs/vpc) for more information on connecting Cloud projects.",
"type": "string"
},
"runtime": {
"description": "The runtime in which to run the function. Required when deploying a new function, optional when updating an existing function. For a complete list of possible choices, see the [`gcloud` command reference](/sdk/gcloud/reference/functions/deploy#--runtime).",
"description": "The runtime in which to run the function. Required when deploying a new function, optional when updating an existing function. For a complete list of possible choices, see the [`gcloud` command reference](https://cloud.google.com/sdk/gcloud/reference/functions/deploy#--runtime).",
"type": "string"
},
"secretEnvironmentVariables": {
"description": "Secret environment variables configuration.",
"items": {
"$ref": "SecretEnvVar"
},
"type": "array"
},
"secretVolumes": {
"description": "Secret volumes configuration.",
"items": {
"$ref": "SecretVolume"
},
"type": "array"
},
"serviceAccountEmail": {
"description": "The email of the function's service account. If empty, defaults to `{project_id}@appspot.gserviceaccount.com`.",
"type": "string"
},
"sourceArchiveUrl": {
"description": "The Google Cloud Storage URL, starting with gs://, pointing to the zip archive which contains the function.",
"description": "The Google Cloud Storage URL, starting with `gs://`, pointing to the zip archive which contains the function.",
"type": "string"
},
"sourceRepository": {
@@ -754,7 +800,7 @@
"type": "string"
},
"sourceUploadUrl": {
"description": "The Google Cloud Storage signed URL used for source uploading, generated by google.cloud.functions.v1.GenerateUploadUrl",
"description": "The Google Cloud Storage signed URL used for source uploading, generated by calling [google.cloud.functions.v1.GenerateUploadUrl]. The signature is validated on write methods (Create, Update) The signature is stripped from the Function object on read methods (Get, List)",
"type": "string"
},
"status": {
@@ -913,6 +959,300 @@
},
"type": "object"
},
"GoogleCloudFunctionsV2alphaOperationMetadata": {
"description": "Represents the metadata of the long-running operation.",
"id": "GoogleCloudFunctionsV2alphaOperationMetadata",
"properties": {
"apiVersion": {
"description": "API version used to start the operation.",
"type": "string"
},
"cancelRequested": {
"description": "Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.",
"type": "boolean"
},
"createTime": {
"description": "The time the operation was created.",
"format": "google-datetime",
"type": "string"
},
"endTime": {
"description": "The time the operation finished running.",
"format": "google-datetime",
"type": "string"
},
"requestResource": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"description": "The original request that started the operation.",
"type": "object"
},
"stages": {
"description": "Mechanism for reporting in-progress stages",
"items": {
"$ref": "GoogleCloudFunctionsV2alphaStage"
},
"type": "array"
},
"statusDetail": {
"description": "Human-readable status of the operation, if any.",
"type": "string"
},
"target": {
"description": "Server-defined resource path for the target of the operation.",
"type": "string"
},
"verb": {
"description": "Name of the verb executed by the operation.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudFunctionsV2alphaStage": {
"description": "Each Stage of the deployment process",
"id": "GoogleCloudFunctionsV2alphaStage",
"properties": {
"message": {
"description": "Message describing the Stage",
"type": "string"
},
"name": {
"description": "Name of the Stage. This will be unique for each Stage.",
"enum": [
"NAME_UNSPECIFIED",
"ARTIFACT_REGISTRY",
"BUILD",
"SERVICE",
"TRIGGER",
"SERVICE_ROLLBACK",
"TRIGGER_ROLLBACK"
],
"enumDescriptions": [
"Not specified. Invalid name.",
"Artifact Regsitry Stage",
"Build Stage",
"Service Stage",
"Trigger Stage",
"Service Rollback Stage",
"Trigger Rollback Stage"
],
"type": "string"
},
"resource": {
"description": "Resource of the Stage",
"type": "string"
},
"resourceUri": {
"description": "Link to the current Stage resource",
"type": "string"
},
"state": {
"description": "Current state of the Stage",
"enum": [
"STATE_UNSPECIFIED",
"NOT_STARTED",
"IN_PROGRESS",
"COMPLETE"
],
"enumDescriptions": [
"Not specified. Invalid state.",
"Stage has not started.",
"Stage is in progress.",
"Stage has completed."
],
"type": "string"
},
"stateMessages": {
"description": "State messages from the current Stage.",
"items": {
"$ref": "GoogleCloudFunctionsV2alphaStateMessage"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudFunctionsV2alphaStateMessage": {
"description": "Informational messages about the state of the Cloud Function or Operation.",
"id": "GoogleCloudFunctionsV2alphaStateMessage",
"properties": {
"message": {
"description": "The message.",
"type": "string"
},
"severity": {
"description": "Severity of the state message.",
"enum": [
"SEVERITY_UNSPECIFIED",
"ERROR",
"WARNING",
"INFO"
],
"enumDescriptions": [
"Not specified. Invalid severity.",
"ERROR-level severity.",
"WARNING-level severity.",
"INFO-level severity."
],
"type": "string"
},
"type": {
"description": "One-word CamelCase type of the state message.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudFunctionsV2betaOperationMetadata": {
"description": "Represents the metadata of the long-running operation.",
"id": "GoogleCloudFunctionsV2betaOperationMetadata",
"properties": {
"apiVersion": {
"description": "API version used to start the operation.",
"type": "string"
},
"cancelRequested": {
"description": "Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.",
"type": "boolean"
},
"createTime": {
"description": "The time the operation was created.",
"format": "google-datetime",
"type": "string"
},
"endTime": {
"description": "The time the operation finished running.",
"format": "google-datetime",
"type": "string"
},
"requestResource": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"description": "The original request that started the operation.",
"type": "object"
},
"stages": {
"description": "Mechanism for reporting in-progress stages",
"items": {
"$ref": "GoogleCloudFunctionsV2betaStage"
},
"type": "array"
},
"statusDetail": {
"description": "Human-readable status of the operation, if any.",
"type": "string"
},
"target": {
"description": "Server-defined resource path for the target of the operation.",
"type": "string"
},
"verb": {
"description": "Name of the verb executed by the operation.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudFunctionsV2betaStage": {
"description": "Each Stage of the deployment process",
"id": "GoogleCloudFunctionsV2betaStage",
"properties": {
"message": {
"description": "Message describing the Stage",
"type": "string"
},
"name": {
"description": "Name of the Stage. This will be unique for each Stage.",
"enum": [
"NAME_UNSPECIFIED",
"ARTIFACT_REGISTRY",
"BUILD",
"SERVICE",
"TRIGGER",
"SERVICE_ROLLBACK",
"TRIGGER_ROLLBACK"
],
"enumDescriptions": [
"Not specified. Invalid name.",
"Artifact Regsitry Stage",
"Build Stage",
"Service Stage",
"Trigger Stage",
"Service Rollback Stage",
"Trigger Rollback Stage"
],
"type": "string"
},
"resource": {
"description": "Resource of the Stage",
"type": "string"
},
"resourceUri": {
"description": "Link to the current Stage resource",
"type": "string"
},
"state": {
"description": "Current state of the Stage",
"enum": [
"STATE_UNSPECIFIED",
"NOT_STARTED",
"IN_PROGRESS",
"COMPLETE"
],
"enumDescriptions": [
"Not specified. Invalid state.",
"Stage has not started.",
"Stage is in progress.",
"Stage has completed."
],
"type": "string"
},
"stateMessages": {
"description": "State messages from the current Stage.",
"items": {
"$ref": "GoogleCloudFunctionsV2betaStateMessage"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudFunctionsV2betaStateMessage": {
"description": "Informational messages about the state of the Cloud Function or Operation.",
"id": "GoogleCloudFunctionsV2betaStateMessage",
"properties": {
"message": {
"description": "The message.",
"type": "string"
},
"severity": {
"description": "Severity of the state message.",
"enum": [
"SEVERITY_UNSPECIFIED",
"ERROR",
"WARNING",
"INFO"
],
"enumDescriptions": [
"Not specified. Invalid severity.",
"ERROR-level severity.",
"WARNING-level severity.",
"INFO-level severity."
],
"type": "string"
},
"type": {
"description": "One-word CamelCase type of the state message.",
"type": "string"
}
},
"type": "object"
},
"HttpsTrigger": {
"description": "Describes HttpsTrigger, could be used to connect web hooks to function.",
"id": "HttpsTrigger",
@@ -1077,6 +1417,10 @@
"description": "The Cloud Build ID of the function created or updated by an API call. This field is only populated for Create and Update operations.",
"type": "string"
},
"buildName": {
"description": "The Cloud Build Name of the function deployment. This field is only populated for Create and Update operations. `projects//locations//builds/`.",
"type": "string"
},
"request": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
@@ -1090,7 +1434,7 @@
"type": "string"
},
"target": {
"description": "Target of the operation - for example projects/project-1/locations/region-1/functions/function-1",
"description": "Target of the operation - for example `projects/project-1/locations/region-1/functions/function-1`",
"type": "string"
},
"type": {
@@ -1123,7 +1467,7 @@
"type": "object"
},
"Policy": {
"description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).",
"description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).",
"id": "Policy",
"properties": {
"auditConfigs": {
@@ -1134,7 +1478,7 @@
"type": "array"
},
"bindings": {
"description": "Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.",
"description": "Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.",
"items": {
"$ref": "Binding"
},
@@ -1159,6 +1503,70 @@
"properties": {},
"type": "object"
},
"SecretEnvVar": {
"description": "Configuration for a secret environment variable. It has the information necessary to fetch the secret value from secret manager and expose it as an environment variable.",
"id": "SecretEnvVar",
"properties": {
"key": {
"description": "Name of the environment variable.",
"type": "string"
},
"projectId": {
"description": "Project identifier (preferrably project number but can also be the project ID) of the project that contains the secret. If not set, it will be populated with the function's project assuming that the secret exists in the same project as of the function.",
"type": "string"
},
"secret": {
"description": "Name of the secret in secret manager (not the full resource name).",
"type": "string"
},
"version": {
"description": "Version of the secret (version number or the string 'latest'). It is recommended to use a numeric version for secret environment variables as any updates to the secret value is not reflected until new instances start.",
"type": "string"
}
},
"type": "object"
},
"SecretVersion": {
"description": "Configuration for a single version.",
"id": "SecretVersion",
"properties": {
"path": {
"description": "Relative path of the file under the mount path where the secret value for this version will be fetched and made available. For example, setting the mount_path as '/etc/secrets' and path as `/secret_foo` would mount the secret value file at `/etc/secrets/secret_foo`.",
"type": "string"
},
"version": {
"description": "Version of the secret (version number or the string 'latest'). It is preferrable to use `latest` version with secret volumes as secret value changes are reflected immediately.",
"type": "string"
}
},
"type": "object"
},
"SecretVolume": {
"description": "Configuration for a secret volume. It has the information necessary to fetch the secret value from secret manager and make it available as files mounted at the requested paths within the application container. Secret value is not a part of the configuration. Every filesystem read operation performs a lookup in secret manager to retrieve the secret value.",
"id": "SecretVolume",
"properties": {
"mountPath": {
"description": "The path within the container to mount the secret volume. For example, setting the mount_path as `/etc/secrets` would mount the secret value files under the `/etc/secrets` directory. This directory will also be completely shadowed and unavailable to mount any other secrets. Recommended mount paths: /etc/secrets Restricted mount paths: /cloudsql, /dev/log, /pod, /proc, /var/log",
"type": "string"
},
"projectId": {
"description": "Project identifier (preferrably project number but can also be the project ID) of the project that contains the secret. If not set, it will be populated with the function's project assuming that the secret exists in the same project as of the function.",
"type": "string"
},
"secret": {
"description": "Name of the secret in secret manager (not the full resource name).",
"type": "string"
},
"versions": {
"description": "List of secret versions to mount for this secret. If empty, the `latest` version of the secret will be made available in a file named after the secret under the mount point.",
"items": {
"$ref": "SecretVersion"
},
"type": "array"
}
},
"type": "object"
},
"SetIamPolicyRequest": {
"description": "Request message for `SetIamPolicy` method.",
"id": "SetIamPolicyRequest",

1729
etc/api/cloudfunctions/v2alpha/cloudfunctions-api.json Normal file
View File

File diff suppressed because it is too large Load Diff

1729
etc/api/cloudfunctions/v2beta/cloudfunctions-api.json Normal file
View File

File diff suppressed because it is too large Load Diff

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

File diff suppressed because it is too large Load Diff

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

File diff suppressed because it is too large Load Diff

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

@@ -3,7 +3,7 @@
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "See, edit, configure, and delete your Google Cloud Platform data"
"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
},
"https://www.googleapis.com/auth/cloudiot": {
"description": "Register and manage devices in the Google Cloud IoT service"
@@ -938,7 +938,7 @@
}
}
},
"revision": "20210323",
"revision": "20220131",
"rootUrl": "https://cloudiot.googleapis.com/",
"schemas": {
"BindDeviceToGatewayRequest": {
@@ -963,22 +963,22 @@
"type": "object"
},
"Binding": {
"description": "Associates `members` with a `role`.",
"description": "Associates `members`, or principals, with a `role`.",
"id": "Binding",
"properties": {
"condition": {
"$ref": "Expr",
"description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)."
"description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)."
},
"members": {
"description": "Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ",
"description": "Specifies the principals requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ",
"items": {
"type": "string"
},
"type": "array"
},
"role": {
"description": "Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.",
"description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.",
"type": "string"
}
},
@@ -1311,7 +1311,7 @@
"id": "GetPolicyOptions",
"properties": {
"requestedPolicyVersion": {
"description": "Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
"format": "int32",
"type": "integer"
}
@@ -1442,11 +1442,11 @@
"type": "object"
},
"Policy": {
"description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).",
"description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).",
"id": "Policy",
"properties": {
"bindings": {
"description": "Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.",
"description": "Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.",
"items": {
"$ref": "Binding"
},

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

File diff suppressed because it is too large Load Diff

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

@@ -3,7 +3,7 @@
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "See, edit, configure, and delete your Google Cloud Platform data"
"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
},
"https://www.googleapis.com/auth/monitoring": {
"description": "View and write monitoring data for all of your Google and third-party Cloud and API projects"
@@ -116,7 +116,7 @@
"profiles": {
"methods": {
"create": {
"description": "CreateProfile creates a new profile resource in the online mode. The server ensures that the new profiles are created at a constant rate per deployment, so the creation request may hang for some time until the next profile session is available. The request may fail with ABORTED error if the creation is not available within ~1m, the response will indicate the duration of the backoff the client should take before attempting creating a profile again. The backoff duration is returned in google.rpc.RetryInfo extension on the response status. To a gRPC client, the extension will be return as a binary-serialized proto in the trailing metadata item named \"google.rpc.retryinfo-bin\".",
"description": "CreateProfile creates a new profile resource in the online mode. The server ensures that the new profiles are created at a constant rate per deployment, so the creation request may hang for some time until the next profile session is available. The request may fail with ABORTED error if the creation is not available within ~1m, the response will indicate the duration of the backoff the client should take before attempting creating a profile again. The backoff duration is returned in google.rpc.RetryInfo extension on the response status. To a gRPC client, the extension will be return as a binary-serialized proto in the trailing metadata item named \"google.rpc.retryinfo-bin\". ",
"flatPath": "v2/projects/{projectsId}/profiles",
"httpMethod": "POST",
"id": "cloudprofiler.projects.profiles.create",
@@ -216,19 +216,19 @@
}
}
},
"revision": "20210326",
"revision": "20220228",
"rootUrl": "https://cloudprofiler.googleapis.com/",
"schemas": {
"CreateProfileRequest": {
"description": "CreateProfileRequest describes a profile resource online creation request. The deployment field must be populated. The profile_type specifies the list of profile types supported by the agent. The creation call will hang until a profile of one of these types needs to be collected.",
"description": "CreateProfileRequest describes a profile resource online creation request. The deployment field must be populated. The profile_type specifies the list of profile types supported by the agent. The creation call will hang until a profile of one of these types needs to be collected. ",
"id": "CreateProfileRequest",
"properties": {
"deployment": {
"$ref": "Deployment",
"description": "Deployment details."
"description": "Required. Deployment details."
},
"profileType": {
"description": "One or more profile types that the agent is capable of providing.",
"description": "Required. One or more profile types that the agent is capable of providing.",
"items": {
"enum": [
"PROFILE_TYPE_UNSPECIFIED",
@@ -273,7 +273,7 @@
"type": "string"
},
"target": {
"description": "Target is the service name used to group related deployments: * Service name for GAE Flex / Standard. * Cluster and container name for GKE. * User-specified string for direct GCE profiling (e.g. Java). * Job name for Dataflow. Validation regex: `^[a-z]([-a-z0-9_.]{0,253}[a-z0-9])?$`.",
"description": "Target is the service name used to group related deployments: * Service name for App Engine Flex / Standard. * Cluster and container name for GKE. * User-specified string for direct Compute Engine profiling (e.g. Java). * Job name for Dataflow. Validation regex: `^[a-z]([-a-z0-9_.]{0,253}[a-z0-9])?$`.",
"type": "string"
}
},
@@ -301,6 +301,7 @@
},
"name": {
"description": "Output only. Opaque, server-assigned, unique ID for this profile.",
"readOnly": true,
"type": "string"
},
"profileBytes": {

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

@@ -3,10 +3,10 @@
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "See, edit, configure, and delete your Google Cloud Platform data"
"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
},
"https://www.googleapis.com/auth/cloud-platform.read-only": {
"description": "View your data across Google Cloud Platform services"
"description": "View your data across Google Cloud services and see the email address of your Google Account"
}
}
}
@@ -365,7 +365,7 @@
"parameterOrder": [],
"parameters": {
"pageSize": {
"description": "The maximum number of items to return. This is a suggestion for the server.",
"description": "The maximum number of items to return. This is a suggestion for the server. The server can return fewer liens than requested. If unspecified, server picks an appropriate default.",
"format": "int32",
"location": "query",
"type": "integer"
@@ -948,7 +948,7 @@
"parameterOrder": [],
"parameters": {
"filter": {
"description": "Optional. An expression for filtering the results of the request. Filter rules are case insensitive. If multiple fields are included in a filter query, the query will return results that match any of the fields. Some eligible fields for filtering are: + `name` + `id` + `labels.` (where *key* is the name of a label) + `parent.type` + `parent.id` + `lifecycleState` Some examples of filter strings: | Filter | Description | |------------------|-----------------------------------------------------| | name:how* | The project's name starts with \"how\". | | name:Howl | The project's name is `Howl` or `howl`. | | name:HOWL | Equivalent to above. | | NAME:howl | Equivalent to above. | | labels.color:* | The project has the label `color`. | | labels.color:red | The project's label `color` has the value `red`. | | labels.color:red labels.size:big | The project's label `color` | : : has the value `red` and its : : : label`size` has the value : : : `big`. : | lifecycleState:DELETE_REQUESTED | Only show projects that are | : : pending deletion. : If no filter is specified, the call will return projects for which the user has the `resourcemanager.projects.get` permission. NOTE: To perform a by-parent query (eg., what projects are directly in a Folder), the caller must have the `resourcemanager.projects.list` permission on the parent and the filter must contain both a `parent.type` and a `parent.id` restriction (example: \"parent.type:folder parent.id:123\"). In this case an alternate search index is used which provides more consistent results.",
"description": "Optional. An expression for filtering the results of the request. Filter rules are case insensitive. If multiple fields are included in a filter query, the query will return results that match any of the fields. Some eligible fields for filtering are: + `name` + `id` + `labels.` (where *key* is the name of a label) + `parent.type` + `parent.id` + `lifecycleState` Some examples of filter queries: | Query | Description | |------------------|-----------------------------------------------------| | name:how* | The project's name starts with \"how\". | | name:Howl | The project's name is `Howl` or `howl`. | | name:HOWL | Equivalent to above. | | NAME:howl | Equivalent to above. | | labels.color:* | The project has the label `color`. | | labels.color:red | The project's label `color` has the value `red`. | | labels.color:red labels.size:big | The project's label `color` has the value `red` and its label `size` has the value `big`.| | lifecycleState:DELETE_REQUESTED | Only show projects that are pending deletion.| If no filter is specified, the call will return projects for which the user has the `resourcemanager.projects.get` permission. NOTE: To perform a by-parent query (eg., what projects are directly in a Folder), the caller must have the `resourcemanager.projects.list` permission on the parent and the filter must contain both a `parent.type` and a `parent.id` restriction (example: \"parent.type:folder parent.id:123\"). In this case an alternate search index is used which provides more consistent results.",
"location": "query",
"type": "string"
},
@@ -1032,7 +1032,7 @@
]
},
"setIamPolicy": {
"description": "Sets the IAM access control policy for the specified Project. CAUTION: This method will replace the existing policy, and cannot be used to append additional IAM settings. NOTE: Removing service accounts from policies or changing their roles can render services completely inoperable. It is important to understand how the service account is being used before removing or updating its roles. For additional information about `resource` (e.g. my-project-id) structure and identification, see [Resource Names](https://cloud.google.com/apis/design/resource_names). The following constraints apply when using `setIamPolicy()`: + Project does not support `allUsers` and `allAuthenticatedUsers` as `members` in a `Binding` of a `Policy`. + The owner role can be granted to a `user`, `serviceAccount`, or a group that is part of an organization. For example, group@myownpersonaldomain.com could be added as an owner to a project in the myownpersonaldomain.com organization, but not the examplepetstore.com organization. + Service accounts can be made owners of a project directly without any restrictions. However, to be added as an owner, a user must be invited via Cloud Platform console and must accept the invitation. + A user cannot be granted the owner role using `setIamPolicy()`. The user must be granted the owner role using the Cloud Platform Console and must explicitly accept the invitation. + You can only grant ownership of a project to a member by using the GCP Console. Inviting a member will deliver an invitation email that they must accept. An invitation email is not generated if you are granting a role other than owner, or if both the member you are inviting and the project are part of your organization. + Membership changes that leave the project without any owners that have accepted the Terms of Service (ToS) will be rejected. + If the project is not part of an organization, there must be at least one owner who has accepted the Terms of Service (ToS) agreement in the policy. Calling `setIamPolicy()` to remove the last ToS-accepted owner from the policy will fail. This restriction also applies to legacy projects that no longer have owners who have accepted the ToS. Edits to IAM policies will be rejected until the lack of a ToS-accepting owner is rectified. Authorization requires the Google IAM permission `resourcemanager.projects.setIamPolicy` on the project",
"description": "Sets the IAM access control policy for the specified Project. CAUTION: This method will replace the existing policy, and cannot be used to append additional IAM settings. NOTE: Removing service accounts from policies or changing their roles can render services completely inoperable. It is important to understand how the service account is being used before removing or updating its roles. For additional information about `resource` (e.g. my-project-id) structure and identification, see [Resource Names](https://cloud.google.com/apis/design/resource_names). The following constraints apply when using `setIamPolicy()`: + Project does not support `allUsers` and `allAuthenticatedUsers` as `members` in a `Binding` of a `Policy`. + The owner role can be granted to a `user`, `serviceAccount`, or a group that is part of an organization. For example, group@myownpersonaldomain.com could be added as an owner to a project in the myownpersonaldomain.com organization, but not the examplepetstore.com organization. + Service accounts can be made owners of a project directly without any restrictions. However, to be added as an owner, a user must be invited via Cloud Platform console and must accept the invitation. + A user cannot be granted the owner role using `setIamPolicy()`. The user must be granted the owner role using the Cloud Platform Console and must explicitly accept the invitation. + You can only grant ownership of a project to a member by using the GCP Console. Inviting a member will deliver an invitation email that they must accept. An invitation email is not generated if you are granting a role other than owner, or if both the member you are inviting and the project are part of your organization. + If the project is not part of an organization, there must be at least one owner who has accepted the Terms of Service (ToS) agreement in the policy. Calling `setIamPolicy()` to remove the last ToS-accepted owner from the policy will fail. This restriction also applies to legacy projects that no longer have owners who have accepted the ToS. Edits to IAM policies will be rejected until the lack of a ToS-accepting owner is rectified. If the project is part of an organization, you can remove all owners, potentially making the organization inaccessible. Authorization requires the Google IAM permission `resourcemanager.projects.setIamPolicy` on the project",
"flatPath": "v1/projects/{resource}:setIamPolicy",
"httpMethod": "POST",
"id": "cloudresourcemanager.projects.setIamPolicy",
@@ -1171,7 +1171,7 @@
}
}
},
"revision": "20210328",
"revision": "20220306",
"rootUrl": "https://cloudresourcemanager.googleapis.com/",
"schemas": {
"Ancestor": {
@@ -1234,22 +1234,22 @@
"type": "object"
},
"Binding": {
"description": "Associates `members` with a `role`.",
"description": "Associates `members`, or principals, with a `role`.",
"id": "Binding",
"properties": {
"condition": {
"$ref": "Expr",
"description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)."
"description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)."
},
"members": {
"description": "Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ",
"description": "Specifies the principals requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ",
"items": {
"type": "string"
},
"type": "array"
},
"role": {
"description": "Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.",
"description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.",
"type": "string"
}
},
@@ -1435,6 +1435,12 @@
},
"type": "object"
},
"CreateTagBindingMetadata": {
"description": "Runtime operation information for creating a TagValue.",
"id": "CreateTagBindingMetadata",
"properties": {},
"type": "object"
},
"CreateTagKeyMetadata": {
"description": "Runtime operation information for creating a TagKey.",
"id": "CreateTagKeyMetadata",
@@ -1465,6 +1471,12 @@
"properties": {},
"type": "object"
},
"DeleteTagBindingMetadata": {
"description": "Runtime operation information for deleting a TagBinding.",
"id": "DeleteTagBindingMetadata",
"properties": {},
"type": "object"
},
"DeleteTagKeyMetadata": {
"description": "Runtime operation information for deleting a TagKey.",
"id": "DeleteTagKeyMetadata",
@@ -1632,7 +1644,7 @@
"id": "GetPolicyOptions",
"properties": {
"requestedPolicyVersion": {
"description": "Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
"format": "int32",
"type": "integer"
}
@@ -1984,7 +1996,7 @@
"type": "object"
},
"Policy": {
"description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).",
"description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).",
"id": "Policy",
"properties": {
"auditConfigs": {
@@ -1995,7 +2007,7 @@
"type": "array"
},
"bindings": {
"description": "Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.",
"description": "Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.",
"items": {
"$ref": "Binding"
},
@@ -2116,7 +2128,7 @@
"type": "string"
},
"pageSize": {
"description": "The maximum number of Organizations to return in the response. This field is optional.",
"description": "The maximum number of Organizations to return in the response. The server can return fewer organizations than requested. If unspecified, server picks an appropriate default.",
"format": "int32",
"type": "integer"
},

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

@@ -3,10 +3,10 @@
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "See, edit, configure, and delete your Google Cloud Platform data"
"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
},
"https://www.googleapis.com/auth/cloud-platform.read-only": {
"description": "View your data across Google Cloud Platform services"
"description": "View your data across Google Cloud services and see the email address of your Google Account"
}
}
}
@@ -566,7 +566,7 @@
}
}
},
"revision": "20210328",
"revision": "20220306",
"rootUrl": "https://cloudresourcemanager.googleapis.com/",
"schemas": {
"Ancestor": {
@@ -629,22 +629,22 @@
"type": "object"
},
"Binding": {
"description": "Associates `members` with a `role`.",
"description": "Associates `members`, or principals, with a `role`.",
"id": "Binding",
"properties": {
"condition": {
"$ref": "Expr",
"description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)."
"description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)."
},
"members": {
"description": "Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ",
"description": "Specifies the principals requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ",
"items": {
"type": "string"
},
"type": "array"
},
"role": {
"description": "Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.",
"description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.",
"type": "string"
}
},
@@ -751,6 +751,12 @@
},
"type": "object"
},
"CreateTagBindingMetadata": {
"description": "Runtime operation information for creating a TagValue.",
"id": "CreateTagBindingMetadata",
"properties": {},
"type": "object"
},
"CreateTagKeyMetadata": {
"description": "Runtime operation information for creating a TagKey.",
"id": "CreateTagKeyMetadata",
@@ -781,6 +787,12 @@
"properties": {},
"type": "object"
},
"DeleteTagBindingMetadata": {
"description": "Runtime operation information for deleting a TagBinding.",
"id": "DeleteTagBindingMetadata",
"properties": {},
"type": "object"
},
"DeleteTagKeyMetadata": {
"description": "Runtime operation information for deleting a TagKey.",
"id": "DeleteTagKeyMetadata",
@@ -926,7 +938,7 @@
"id": "GetPolicyOptions",
"properties": {
"requestedPolicyVersion": {
"description": "Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
"format": "int32",
"type": "integer"
}
@@ -1048,7 +1060,7 @@
"type": "object"
},
"Policy": {
"description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).",
"description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).",
"id": "Policy",
"properties": {
"auditConfigs": {
@@ -1059,7 +1071,7 @@
"type": "array"
},
"bindings": {
"description": "Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.",
"description": "Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.",
"items": {
"$ref": "Binding"
},

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

@@ -3,10 +3,10 @@
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "See, edit, configure, and delete your Google Cloud Platform data"
"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
},
"https://www.googleapis.com/auth/cloud-platform.read-only": {
"description": "View your data across Google Cloud Platform services"
"description": "View your data across Google Cloud services and see the email address of your Google Account"
}
}
}
@@ -222,7 +222,7 @@
"parameterOrder": [],
"parameters": {
"pageSize": {
"description": "Optional. The maximum number of Folders to return in the response.",
"description": "Optional. The maximum number of Folders to return in the response. The server can return fewer folders than requested. If unspecified, server picks an appropriate default.",
"format": "int32",
"location": "query",
"type": "integer"
@@ -450,7 +450,7 @@
}
}
},
"revision": "20210328",
"revision": "20220306",
"rootUrl": "https://cloudresourcemanager.googleapis.com/",
"schemas": {
"AuditConfig": {
@@ -502,22 +502,22 @@
"type": "object"
},
"Binding": {
"description": "Associates `members` with a `role`.",
"description": "Associates `members`, or principals, with a `role`.",
"id": "Binding",
"properties": {
"condition": {
"$ref": "Expr",
"description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)."
"description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)."
},
"members": {
"description": "Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ",
"description": "Specifies the principals requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ",
"items": {
"type": "string"
},
"type": "array"
},
"role": {
"description": "Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.",
"description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.",
"type": "string"
}
},
@@ -624,6 +624,12 @@
},
"type": "object"
},
"CreateTagBindingMetadata": {
"description": "Runtime operation information for creating a TagValue.",
"id": "CreateTagBindingMetadata",
"properties": {},
"type": "object"
},
"CreateTagKeyMetadata": {
"description": "Runtime operation information for creating a TagKey.",
"id": "CreateTagKeyMetadata",
@@ -654,6 +660,12 @@
"properties": {},
"type": "object"
},
"DeleteTagBindingMetadata": {
"description": "Runtime operation information for deleting a TagBinding.",
"id": "DeleteTagBindingMetadata",
"properties": {},
"type": "object"
},
"DeleteTagKeyMetadata": {
"description": "Runtime operation information for deleting a TagKey.",
"id": "DeleteTagKeyMetadata",
@@ -814,7 +826,7 @@
"id": "GetPolicyOptions",
"properties": {
"requestedPolicyVersion": {
"description": "Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
"format": "int32",
"type": "integer"
}
@@ -911,7 +923,7 @@
"type": "object"
},
"Policy": {
"description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).",
"description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).",
"id": "Policy",
"properties": {
"auditConfigs": {
@@ -922,7 +934,7 @@
"type": "array"
},
"bindings": {
"description": "Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.",
"description": "Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.",
"items": {
"$ref": "Binding"
},
@@ -966,7 +978,7 @@
"id": "SearchFoldersRequest",
"properties": {
"pageSize": {
"description": "Optional. The maximum number of folders to return in the response.",
"description": "Optional. The maximum number of folders to return in the response. The server can return fewer folders than requested. If unspecified, server picks an appropriate default.",
"format": "int32",
"type": "integer"
},

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

@@ -3,10 +3,10 @@
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "See, edit, configure, and delete your Google Cloud Platform data"
"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
},
"https://www.googleapis.com/auth/cloud-platform.read-only": {
"description": "View your data across Google Cloud Platform services"
"description": "View your data across Google Cloud services and see the email address of your Google Account"
}
}
}
@@ -222,7 +222,7 @@
"parameterOrder": [],
"parameters": {
"pageSize": {
"description": "Optional. The maximum number of Folders to return in the response.",
"description": "Optional. The maximum number of Folders to return in the response. The server can return fewer folders than requested. If unspecified, server picks an appropriate default.",
"format": "int32",
"location": "query",
"type": "integer"
@@ -450,7 +450,7 @@
}
}
},
"revision": "20210328",
"revision": "20220306",
"rootUrl": "https://cloudresourcemanager.googleapis.com/",
"schemas": {
"AuditConfig": {
@@ -502,22 +502,22 @@
"type": "object"
},
"Binding": {
"description": "Associates `members` with a `role`.",
"description": "Associates `members`, or principals, with a `role`.",
"id": "Binding",
"properties": {
"condition": {
"$ref": "Expr",
"description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)."
"description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)."
},
"members": {
"description": "Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ",
"description": "Specifies the principals requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ",
"items": {
"type": "string"
},
"type": "array"
},
"role": {
"description": "Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.",
"description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.",
"type": "string"
}
},
@@ -624,6 +624,12 @@
},
"type": "object"
},
"CreateTagBindingMetadata": {
"description": "Runtime operation information for creating a TagValue.",
"id": "CreateTagBindingMetadata",
"properties": {},
"type": "object"
},
"CreateTagKeyMetadata": {
"description": "Runtime operation information for creating a TagKey.",
"id": "CreateTagKeyMetadata",
@@ -654,6 +660,12 @@
"properties": {},
"type": "object"
},
"DeleteTagBindingMetadata": {
"description": "Runtime operation information for deleting a TagBinding.",
"id": "DeleteTagBindingMetadata",
"properties": {},
"type": "object"
},
"DeleteTagKeyMetadata": {
"description": "Runtime operation information for deleting a TagKey.",
"id": "DeleteTagKeyMetadata",
@@ -814,7 +826,7 @@
"id": "GetPolicyOptions",
"properties": {
"requestedPolicyVersion": {
"description": "Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
"format": "int32",
"type": "integer"
}
@@ -911,7 +923,7 @@
"type": "object"
},
"Policy": {
"description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).",
"description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).",
"id": "Policy",
"properties": {
"auditConfigs": {
@@ -922,7 +934,7 @@
"type": "array"
},
"bindings": {
"description": "Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.",
"description": "Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.",
"items": {
"$ref": "Binding"
},
@@ -966,7 +978,7 @@
"id": "SearchFoldersRequest",
"properties": {
"pageSize": {
"description": "Optional. The maximum number of folders to return in the response.",
"description": "Optional. The maximum number of folders to return in the response. The server can return fewer folders than requested. If unspecified, server picks an appropriate default.",
"format": "int32",
"type": "integer"
},

60
etc/api/cloudresourcemanager/v3/cloudresourcemanager-api.json
View File

@@ -3,10 +3,10 @@
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "See, edit, configure, and delete your Google Cloud Platform data"
"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
},
"https://www.googleapis.com/auth/cloud-platform.read-only": {
"description": "View your data across Google Cloud Platform services"
"description": "View your data across Google Cloud services and see the email address of your Google Account"
}
}
}
@@ -216,7 +216,7 @@
"parameterOrder": [],
"parameters": {
"pageSize": {
"description": "Optional. The maximum number of folders to return in the response. If unspecified, server picks an appropriate default.",
"description": "Optional. The maximum number of folders to return in the response. The server can return fewer folders than requested. If unspecified, server picks an appropriate default.",
"format": "int32",
"location": "query",
"type": "integer"
@@ -316,7 +316,7 @@
"parameterOrder": [],
"parameters": {
"pageSize": {
"description": "Optional. The maximum number of folders to return in the response. If unspecified, server picks an appropriate default.",
"description": "Optional. The maximum number of folders to return in the response. The server can return fewer folders than requested. If unspecified, server picks an appropriate default.",
"format": "int32",
"location": "query",
"type": "integer"
@@ -327,7 +327,7 @@
"type": "string"
},
"query": {
"description": "Optional. Search criteria used to select the folders to return. If no search criteria is specified then all accessible folders will be returned. Query expressions can be used to restrict results based upon displayName, state and parent, where the operators `=` (`:`) `NOT`, `AND` and `OR` can be used along with the suffix wildcard symbol `*`. The `displayName` field in a query expression should use escaped quotes for values that include whitespace to prevent unexpected behavior. | Field | Description | |-------------------------|----------------------------------------| | displayName | Filters by displayName. | | parent | Filters by parent (for example: folders/123). | | state, lifecycleState | Filters by state. | Some example queries are: * Query `displayName=Test*` returns Folder resources whose display name starts with \"Test\". * Query `state=ACTIVE` returns Folder resources with `state` set to `ACTIVE`. * Query `parent=folders/123` returns Folder resources that have `folders/123` as a parent resource. * Query `parent=folders/123 AND state=ACTIVE` returns active Folder resources that have `folders/123` as a parent resource. * Query `displayName=\\\\\"Test String\\\\\"` returns Folder resources with display names that include both \"Test\" and \"String\".",
"description": "Optional. Search criteria used to select the folders to return. If no search criteria is specified then all accessible folders will be returned. Query expressions can be used to restrict results based upon displayName, state and parent, where the operators `=` (`:`) `NOT`, `AND` and `OR` can be used along with the suffix wildcard symbol `*`. The `displayName` field in a query expression should use escaped quotes for values that include whitespace to prevent unexpected behavior. ``` | Field | Description | |-------------------------|----------------------------------------| | displayName | Filters by displayName. | | parent | Filters by parent (for example: folders/123). | | state, lifecycleState | Filters by state. | ``` Some example queries are: * Query `displayName=Test*` returns Folder resources whose display name starts with \"Test\". * Query `state=ACTIVE` returns Folder resources with `state` set to `ACTIVE`. * Query `parent=folders/123` returns Folder resources that have `folders/123` as a parent resource. * Query `parent=folders/123 AND state=ACTIVE` returns active Folder resources that have `folders/123` as a parent resource. * Query `displayName=\\\\\"Test String\\\\\"` returns Folder resources with display names that include both \"Test\" and \"String\".",
"location": "query",
"type": "string"
}
@@ -508,7 +508,7 @@
"parameterOrder": [],
"parameters": {
"pageSize": {
"description": "The maximum number of items to return. This is a suggestion for the server.",
"description": "The maximum number of items to return. This is a suggestion for the server. The server can return fewer liens than requested. If unspecified, server picks an appropriate default.",
"format": "int32",
"location": "query",
"type": "integer"
@@ -630,7 +630,7 @@
"parameterOrder": [],
"parameters": {
"pageSize": {
"description": "Optional. The maximum number of organizations to return in the response. If unspecified, server picks an appropriate default.",
"description": "Optional. The maximum number of organizations to return in the response. The server can return fewer organizations than requested. If unspecified, server picks an appropriate default.",
"format": "int32",
"location": "query",
"type": "integer"
@@ -641,7 +641,7 @@
"type": "string"
},
"query": {
"description": "Optional. An optional query string used to filter the Organizations to return in the response. Query rules are case-insensitive. | Field | Description | |------------------|--------------------------------------------| | directoryCustomerId, owner.directoryCustomerId | Filters by directory customer id. | | domain | Filters by domain. | Organizations may be queried by `directoryCustomerId` or by `domain`, where the domain is a G Suite domain, for example: * Query `directorycustomerid:123456789` returns Organization resources with `owner.directory_customer_id` equal to `123456789`. * Query `domain:google.com` returns Organization resources corresponding to the domain `google.com`.",
"description": "Optional. An optional query string used to filter the Organizations to return in the response. Query rules are case-insensitive. ``` | Field | Description | |------------------|--------------------------------------------| | directoryCustomerId, owner.directoryCustomerId | Filters by directory customer id. | | domain | Filters by domain. | ``` Organizations may be queried by `directoryCustomerId` or by `domain`, where the domain is a G Suite domain, for example: * Query `directorycustomerid:123456789` returns Organization resources with `owner.directory_customer_id` equal to `123456789`. * Query `domain:google.com` returns Organization resources corresponding to the domain `google.com`.",
"location": "query",
"type": "string"
}
@@ -786,7 +786,7 @@
]
},
"getIamPolicy": {
"description": "Returns the IAM access control policy for the specified project. Permission is denied if the policy or the resource do not exist.",
"description": "Returns the IAM access control policy for the specified project, in the format `projects/{ProjectIdOrNumber}` e.g. projects/123. Permission is denied if the policy or the resource do not exist.",
"flatPath": "v3/projects/{projectsId}:getIamPolicy",
"httpMethod": "POST",
"id": "cloudresourcemanager.projects.getIamPolicy",
@@ -853,7 +853,7 @@
]
},
"move": {
"description": "Move a project to another place in your resource hierarchy, under a new resource parent. Returns an operation which can be used to track the process of the project move workflow. Upon success, the `Operation.response` field will be populated with the moved project. The caller must have `resourcemanager.projects.update` permission on the project and have `resourcemanager.projects.move` permission on the project's current and proposed new parent. ",
"description": "Move a project to another place in your resource hierarchy, under a new resource parent. Returns an operation which can be used to track the process of the project move workflow. Upon success, the `Operation.response` field will be populated with the moved project. The caller must have `resourcemanager.projects.move` permission on the project, on the project's current and proposed new parent. If project has no current parent, or it currently does not have an associated organization resource, you will also need the `resourcemanager.projects.setIamPolicy` permission in the project. ",
"flatPath": "v3/projects/{projectsId}:move",
"httpMethod": "POST",
"id": "cloudresourcemanager.projects.move",
@@ -933,7 +933,7 @@
"type": "string"
},
"query": {
"description": "Optional. A query string for searching for projects that the caller has `resourcemanager.projects.get` permission to. If multiple fields are included in the query, the it will return results that match any of the fields. Some eligible fields are: | Field | Description | |-------------------------|----------------------------------------------| | displayName, name | Filters by displayName. | | parent | Project's parent. (for example: folders/123, organizations/*) Prefer parent field over parent.type and parent.id. | | parent.type | Parent's type: `folder` or `organization`. | | parent.id | Parent's id number (for example: 123) | | id, projectId | Filters by projectId. | | state, lifecycleState | Filters by state. | | labels | Filters by label name or value. | | labels. (where *key* is the name of a label) | Filters by label name. | Search expressions are case insensitive. Some examples queries: | Query | Description | |------------------|-----------------------------------------------------| | name:how* | The project's name starts with \"how\". | | name:Howl | The project's name is `Howl` or `howl`. | | name:HOWL | Equivalent to above. | | NAME:howl | Equivalent to above. | | labels.color:* | The project has the label `color`. | | labels.color:red | The project's label `color` has the value `red`. | | labels.color:red labels.size:big | The project's label `color` has the value `red` and its label `size` has the value `big`. | If no query is specified, the call will return projects for which the user has the `resourcemanager.projects.get` permission.",
"description": "Optional. A query string for searching for projects that the caller has `resourcemanager.projects.get` permission to. If multiple fields are included in the query, then it will return results that match any of the fields. Some eligible fields are: ``` | Field | Description | |-------------------------|----------------------------------------------| | displayName, name | Filters by displayName. | | parent | Project's parent (for example: folders/123, organizations/*). Prefer parent field over parent.type and parent.id.| | parent.type | Parent's type: `folder` or `organization`. | | parent.id | Parent's id number (for example: 123) | | id, projectId | Filters by projectId. | | state, lifecycleState | Filters by state. | | labels | Filters by label name or value. | | labels.\\ (where *key* is the name of a label) | Filters by label name.| ``` Search expressions are case insensitive. Some examples queries: ``` | Query | Description | |------------------|-----------------------------------------------------| | name:how* | The project's name starts with \"how\". | | name:Howl | The project's name is `Howl` or `howl`. | | name:HOWL | Equivalent to above. | | NAME:howl | Equivalent to above. | | labels.color:* | The project has the label `color`. | | labels.color:red | The project's label `color` has the value `red`. | | labels.color:red labels.size:big | The project's label `color` has the value `red` and its label `size` has the value `big`.| ``` If no query is specified, the call will return projects for which the user has the `resourcemanager.projects.get` permission.",
"location": "query",
"type": "string"
}
@@ -947,7 +947,7 @@
]
},
"setIamPolicy": {
"description": "Sets the IAM access control policy for the specified project. CAUTION: This method will replace the existing policy, and cannot be used to append additional IAM settings. Note: Removing service accounts from policies or changing their roles can render services completely inoperable. It is important to understand how the service account is being used before removing or updating its roles. The following constraints apply when using `setIamPolicy()`: + Project does not support `allUsers` and `allAuthenticatedUsers` as `members` in a `Binding` of a `Policy`. + The owner role can be granted to a `user`, `serviceAccount`, or a group that is part of an organization. For example, group@myownpersonaldomain.com could be added as an owner to a project in the myownpersonaldomain.com organization, but not the examplepetstore.com organization. + Service accounts can be made owners of a project directly without any restrictions. However, to be added as an owner, a user must be invited using the Cloud Platform console and must accept the invitation. + A user cannot be granted the owner role using `setIamPolicy()`. The user must be granted the owner role using the Cloud Platform Console and must explicitly accept the invitation. + Invitations to grant the owner role cannot be sent using `setIamPolicy()`; they must be sent only using the Cloud Platform Console. + Membership changes that leave the project without any owners that have accepted the Terms of Service (ToS) will be rejected. + If the project is not part of an organization, there must be at least one owner who has accepted the Terms of Service (ToS) agreement in the policy. Calling `setIamPolicy()` to remove the last ToS-accepted owner from the policy will fail. This restriction also applies to legacy projects that no longer have owners who have accepted the ToS. Edits to IAM policies will be rejected until the lack of a ToS-accepting owner is rectified. + Calling this method requires enabling the App Engine Admin API.",
"description": "Sets the IAM access control policy for the specified project, in the format `projects/{ProjectIdOrNumber}` e.g. projects/123. CAUTION: This method will replace the existing policy, and cannot be used to append additional IAM settings. Note: Removing service accounts from policies or changing their roles can render services completely inoperable. It is important to understand how the service account is being used before removing or updating its roles. The following constraints apply when using `setIamPolicy()`: + Project does not support `allUsers` and `allAuthenticatedUsers` as `members` in a `Binding` of a `Policy`. + The owner role can be granted to a `user`, `serviceAccount`, or a group that is part of an organization. For example, group@myownpersonaldomain.com could be added as an owner to a project in the myownpersonaldomain.com organization, but not the examplepetstore.com organization. + Service accounts can be made owners of a project directly without any restrictions. However, to be added as an owner, a user must be invited using the Cloud Platform console and must accept the invitation. + A user cannot be granted the owner role using `setIamPolicy()`. The user must be granted the owner role using the Cloud Platform Console and must explicitly accept the invitation. + Invitations to grant the owner role cannot be sent using `setIamPolicy()`; they must be sent only using the Cloud Platform Console. + If the project is not part of an organization, there must be at least one owner who has accepted the Terms of Service (ToS) agreement in the policy. Calling `setIamPolicy()` to remove the last ToS-accepted owner from the policy will fail. This restriction also applies to legacy projects that no longer have owners who have accepted the ToS. Edits to IAM policies will be rejected until the lack of a ToS-accepting owner is rectified. If the project is part of an organization, you can remove all owners, potentially making the organization inaccessible. + Calling this method requires enabling the App Engine Admin API.",
"flatPath": "v3/projects/{projectsId}:setIamPolicy",
"httpMethod": "POST",
"id": "cloudresourcemanager.projects.setIamPolicy",
@@ -975,7 +975,7 @@
]
},
"testIamPermissions": {
"description": "Returns permissions that a caller has on the specified project.",
"description": "Returns permissions that a caller has on the specified project, in the format `projects/{ProjectIdOrNumber}` e.g. projects/123..",
"flatPath": "v3/projects/{projectsId}:testIamPermissions",
"httpMethod": "POST",
"id": "cloudresourcemanager.projects.testIamPermissions",
@@ -1092,13 +1092,13 @@
"parameterOrder": [],
"parameters": {
"pageSize": {
"description": "Optional. The maximum number of TagBindings to return in the response. The server allows a maximum of 300 TagBindings to return. If unspecified, the server will use 100 as the default.",
"description": "Optional. The maximum number of TagBindings to return in the response. The server allows a maximum of 300 TagBindings to return. If unspecified, the server will use 100 as the default. Currently this api returns unpaginated response and `page_size` is ignored.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. A pagination token returned from a previous call to `ListTagBindings` that indicates where this listing should continue from.",
"description": "Optional. A pagination token returned from a previous call to `ListTagBindings` that indicates where this listing should continue from. Currently this api returns unpaginated response and `page_token` is ignored.",
"location": "query",
"type": "string"
},
@@ -1612,7 +1612,7 @@
}
}
},
"revision": "20210328",
"revision": "20220306",
"rootUrl": "https://cloudresourcemanager.googleapis.com/",
"schemas": {
"AuditConfig": {
@@ -1664,22 +1664,22 @@
"type": "object"
},
"Binding": {
"description": "Associates `members` with a `role`.",
"description": "Associates `members`, or principals, with a `role`.",
"id": "Binding",
"properties": {
"condition": {
"$ref": "Expr",
"description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)."
"description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)."
},
"members": {
"description": "Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ",
"description": "Specifies the principals requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ",
"items": {
"type": "string"
},
"type": "array"
},
"role": {
"description": "Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.",
"description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.",
"type": "string"
}
},
@@ -1786,6 +1786,12 @@
},
"type": "object"
},
"CreateTagBindingMetadata": {
"description": "Runtime operation information for creating a TagValue.",
"id": "CreateTagBindingMetadata",
"properties": {},
"type": "object"
},
"CreateTagKeyMetadata": {
"description": "Runtime operation information for creating a TagKey.",
"id": "CreateTagKeyMetadata",
@@ -1816,6 +1822,12 @@
"properties": {},
"type": "object"
},
"DeleteTagBindingMetadata": {
"description": "Runtime operation information for deleting a TagBinding.",
"id": "DeleteTagBindingMetadata",
"properties": {},
"type": "object"
},
"DeleteTagKeyMetadata": {
"description": "Runtime operation information for deleting a TagKey.",
"id": "DeleteTagKeyMetadata",
@@ -1999,7 +2011,7 @@
"id": "GetPolicyOptions",
"properties": {
"requestedPolicyVersion": {
"description": "Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
"format": "int32",
"type": "integer"
}
@@ -2104,7 +2116,7 @@
"type": "string"
},
"tagBindings": {
"description": "A possibly paginated list of TagBindings for the specified TagValue or resource.",
"description": "A possibly paginated list of TagBindings for the specified resource.",
"items": {
"$ref": "TagBinding"
},
@@ -2291,7 +2303,7 @@
"type": "object"
},
"Policy": {
"description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).",
"description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).",
"id": "Policy",
"properties": {
"auditConfigs": {
@@ -2302,7 +2314,7 @@
"type": "array"
},
"bindings": {
"description": "Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.",
"description": "Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.",
"items": {
"$ref": "Binding"
},

20
etc/api/cloudscheduler/v1/cloudscheduler-api.json
View File

@@ -3,7 +3,7 @@
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "View and manage your data across Google Cloud Platform services"
"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
}
}
}
@@ -156,7 +156,7 @@
"type": "string"
},
"pageSize": {
"description": "The maximum number of results to return. If not set, the service will select a default.",
"description": "The maximum number of results to return. If not set, the service selects a default.",
"format": "int32",
"location": "query",
"type": "integer"
@@ -418,7 +418,7 @@
}
}
},
"revision": "20210315",
"revision": "20220212",
"rootUrl": "https://cloudscheduler.googleapis.com/",
"schemas": {
"AppEngineHttpTarget": {
@@ -438,7 +438,7 @@
"additionalProperties": {
"type": "string"
},
"description": "HTTP request headers. This map contains the header field names and values. Headers can be set when the job is created. Cloud Scheduler sets some headers to default values: * `User-Agent`: By default, this header is `\"AppEngine-Google; (+http://code.google.com/appengine)\"`. This header can be modified, but Cloud Scheduler will append `\"AppEngine-Google; (+http://code.google.com/appengine)\"` to the modified `User-Agent`. * `X-CloudScheduler`: This header will be set to true. If the job has an body, Cloud Scheduler sets the following headers: * `Content-Type`: By default, the `Content-Type` header is set to `\"application/octet-stream\"`. The default can be overridden by explictly setting `Content-Type` to a particular media type when the job is created. For example, `Content-Type` can be set to `\"application/json\"`. * `Content-Length`: This is computed by Cloud Scheduler. This value is output only. It cannot be changed. The headers below are output only. They cannot be set or overridden: * `X-Google-*`: For Google internal use only. * `X-AppEngine-*`: For Google internal use only. In addition, some App Engine headers, which contain job-specific information, are also be sent to the job handler.",
"description": "HTTP request headers. This map contains the header field names and values. Headers can be set when the job is created. Cloud Scheduler sets some headers to default values: * `User-Agent`: By default, this header is `\"AppEngine-Google; (+http://code.google.com/appengine)\"`. This header can be modified, but Cloud Scheduler will append `\"AppEngine-Google; (+http://code.google.com/appengine)\"` to the modified `User-Agent`. * `X-CloudScheduler`: This header will be set to true. * `X-CloudScheduler-JobName`: This header will contain the job name. * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule time in RFC3339 UTC \"Zulu\" format. If the job has an body, Cloud Scheduler sets the following headers: * `Content-Type`: By default, the `Content-Type` header is set to `\"application/octet-stream\"`. The default can be overridden by explictly setting `Content-Type` to a particular media type when the job is created. For example, `Content-Type` can be set to `\"application/json\"`. * `Content-Length`: This is computed by Cloud Scheduler. This value is output only. It cannot be changed. The headers below are output only. They cannot be set or overridden: * `X-Google-*`: For Google internal use only. * `X-AppEngine-*`: For Google internal use only. In addition, some App Engine headers, which contain job-specific information, are also be sent to the job handler.",
"type": "object"
},
"httpMethod": {
@@ -481,7 +481,7 @@
"type": "string"
},
"instance": {
"description": "App instance. By default, the job is sent to an instance which is available when the job is attempted. Requests can only be sent to a specific instance if [manual scaling is used in App Engine Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes). App Engine Flex does not support instances. For more information, see [App Engine Standard request routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed) and [App Engine Flex request routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).",
"description": "App instance. By default, the job is sent to an instance which is available when the job is attempted. Requests can only be sent to a specific instance if [manual scaling is used in App Engine Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?#scaling_types_and_instance_classes). App Engine Flex does not support instances. For more information, see [App Engine Standard request routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed) and [App Engine Flex request routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).",
"type": "string"
},
"service": {
@@ -514,7 +514,7 @@
"additionalProperties": {
"type": "string"
},
"description": "The user can specify HTTP request headers to send with the job's HTTP request. This map contains the header field names and values. Repeated headers are not supported, but a header value can contain commas. These headers represent a subset of the headers that will accompany the job's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is below: - Host: This will be computed by Cloud Scheduler and derived from uri. * `Content-Length`: This will be computed by Cloud Scheduler. * `User-Agent`: This will be set to `\"Google-Cloud-Scheduler\"`. * `X-Google-*`: Google internal use only. * `X-AppEngine-*`: Google internal use only. The total size of headers must be less than 80KB.",
"description": "The user can specify HTTP request headers to send with the job's HTTP request. This map contains the header field names and values. Repeated headers are not supported, but a header value can contain commas. These headers represent a subset of the headers that will accompany the job's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is below: - Host: This will be computed by Cloud Scheduler and derived from uri. * `Content-Length`: This will be computed by Cloud Scheduler. * `User-Agent`: This will be set to `\"Google-Cloud-Scheduler\"`. * `X-Google-*`: Google internal use only. * `X-AppEngine-*`: Google internal use only. * `X-CloudScheduler`: This header will be set to true. * `X-CloudScheduler-JobName`: This header will contain the job name. * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule time in RFC3339 UTC \"Zulu\" format. The total size of headers must be less than 80KB.",
"type": "object"
},
"httpMethod": {
@@ -557,7 +557,7 @@
"type": "object"
},
"Job": {
"description": "Configuration for a job. The maximum allowed size for a job is 100KB.",
"description": "Configuration for a job. The maximum allowed size for a job is 1MB.",
"id": "Job",
"properties": {
"appEngineHttpTarget": {
@@ -565,7 +565,7 @@
"description": "App Engine HTTP target."
},
"attemptDeadline": {
"description": "The deadline for job attempts. If the request handler does not respond by this deadline then the request is cancelled and the attempt is marked as a `DEADLINE_EXCEEDED` failure. The failed attempt can be viewed in execution logs. Cloud Scheduler will retry the job according to the RetryConfig. The allowed duration for this deadline is: * For HTTP targets, between 15 seconds and 30 minutes. * For App Engine HTTP targets, between 15 seconds and 24 hours.",
"description": "The deadline for job attempts. If the request handler does not respond by this deadline then the request is cancelled and the attempt is marked as a `DEADLINE_EXCEEDED` failure. The failed attempt can be viewed in execution logs. Cloud Scheduler will retry the job according to the RetryConfig. The allowed duration for this deadline is: * For HTTP targets, between 15 seconds and 30 minutes. * For App Engine HTTP targets, between 15 seconds and 24 hours 15 seconds.",
"format": "google-duration",
"type": "string"
},
@@ -595,7 +595,7 @@
"description": "Settings that determine the retry behavior."
},
"schedule": {
"description": "Required, except when used with UpdateJob. Describes the schedule on which the job will be executed. The schedule can be either of the following types: * [Crontab](http://en.wikipedia.org/wiki/Cron#Overview) * English-like [schedule](https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules) As a general rule, execution `n + 1` of a job will not begin until execution `n` has finished. Cloud Scheduler will never allow two simultaneously outstanding executions. For example, this implies that if the `n+1`th execution is scheduled to run at 16:00 but the `n`th execution takes until 16:15, the `n+1`th execution will not start until `16:15`. A scheduled start time will be delayed if the previous execution has not ended when its scheduled time occurs. If retry_count > 0 and a job attempt fails, the job will be tried a total of retry_count times, with exponential backoff, until the next scheduled start time.",
"description": "Required, except when used with UpdateJob. Describes the schedule on which the job will be executed. The schedule can be either of the following types: * [Crontab](https://en.wikipedia.org/wiki/Cron#Overview) * English-like [schedule](https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules) As a general rule, execution `n + 1` of a job will not begin until execution `n` has finished. Cloud Scheduler will never allow two simultaneously outstanding executions. For example, this implies that if the `n+1`th execution is scheduled to run at 16:00 but the `n`th execution takes until 16:15, the `n+1`th execution will not start until `16:15`. A scheduled start time will be delayed if the previous execution has not ended when its scheduled time occurs. If retry_count > 0 and a job attempt fails, the job will be tried a total of retry_count times, with exponential backoff, until the next scheduled start time.",
"type": "string"
},
"scheduleTime": {
@@ -792,7 +792,7 @@
"type": "string"
},
"topicName": {
"description": "Required. The name of the Cloud Pub/Sub topic to which messages will be published when a job is delivered. The topic name must be in the same format as required by PubSub's [PublishRequest.name](https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#publishrequest), for example `projects/PROJECT_ID/topics/TOPIC_ID`. The topic must be in the same project as the Cloud Scheduler job.",
"description": "Required. The name of the Cloud Pub/Sub topic to which messages will be published when a job is delivered. The topic name must be in the same format as required by Pub/Sub's [PublishRequest.name](https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#publishrequest), for example `projects/PROJECT_ID/topics/TOPIC_ID`. The topic must be in the same project as the Cloud Scheduler job.",
"type": "string"
}
},

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

@@ -3,7 +3,7 @@
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "View and manage your data across Google Cloud Platform services"
"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
}
}
}
@@ -156,7 +156,7 @@
"type": "string"
},
"pageSize": {
"description": "The maximum number of results to return. If not set, the service will select a default.",
"description": "The maximum number of results to return. If not set, the service selects a default.",
"format": "int32",
"location": "query",
"type": "integer"
@@ -271,6 +271,11 @@
"parent"
],
"parameters": {
"filter": {
"description": "`filter` can be used to specify a subset of jobs. If `filter` equals `target_config=\"HttpConfig\"`, then the http target jobs are retrieved. If `filter` equals `target_config=\"PubSubConfig\"`, then the Pub/Sub target jobs are retrieved. If `filter` equals `labels.foo=value1 labels.foo=value2` then only jobs which are labeled with foo=value1 AND foo=value2 will be returned.",
"location": "query",
"type": "string"
},
"legacyAppEngineCron": {
"description": "This field is used to manage the legacy App Engine Cron jobs using the Cloud Scheduler API. If the field is set to true, the jobs in the __cron queue will be listed instead.",
"location": "query",
@@ -428,7 +433,7 @@
}
}
},
"revision": "20210315",
"revision": "20220212",
"rootUrl": "https://cloudscheduler.googleapis.com/",
"schemas": {
"AppEngineHttpTarget": {
@@ -448,7 +453,7 @@
"additionalProperties": {
"type": "string"
},
"description": "HTTP request headers. This map contains the header field names and values. Headers can be set when the job is created. Cloud Scheduler sets some headers to default values: * `User-Agent`: By default, this header is `\"AppEngine-Google; (+http://code.google.com/appengine)\"`. This header can be modified, but Cloud Scheduler will append `\"AppEngine-Google; (+http://code.google.com/appengine)\"` to the modified `User-Agent`. * `X-CloudScheduler`: This header will be set to true. If the job has an body, Cloud Scheduler sets the following headers: * `Content-Type`: By default, the `Content-Type` header is set to `\"application/octet-stream\"`. The default can be overridden by explictly setting `Content-Type` to a particular media type when the job is created. For example, `Content-Type` can be set to `\"application/json\"`. * `Content-Length`: This is computed by Cloud Scheduler. This value is output only. It cannot be changed. The headers below are output only. They cannot be set or overridden: * `X-Google-*`: For Google internal use only. * `X-AppEngine-*`: For Google internal use only. In addition, some App Engine headers, which contain job-specific information, are also be sent to the job handler.",
"description": "HTTP request headers. This map contains the header field names and values. Headers can be set when the job is created. Cloud Scheduler sets some headers to default values: * `User-Agent`: By default, this header is `\"AppEngine-Google; (+http://code.google.com/appengine)\"`. This header can be modified, but Cloud Scheduler will append `\"AppEngine-Google; (+http://code.google.com/appengine)\"` to the modified `User-Agent`. * `X-CloudScheduler`: This header will be set to true. * `X-CloudScheduler-JobName`: This header will contain the job name. * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule time in RFC3339 UTC \"Zulu\" format. If the job has an body, Cloud Scheduler sets the following headers: * `Content-Type`: By default, the `Content-Type` header is set to `\"application/octet-stream\"`. The default can be overridden by explictly setting `Content-Type` to a particular media type when the job is created. For example, `Content-Type` can be set to `\"application/json\"`. * `Content-Length`: This is computed by Cloud Scheduler. This value is output only. It cannot be changed. The headers below are output only. They cannot be set or overridden: * `X-Google-*`: For Google internal use only. * `X-AppEngine-*`: For Google internal use only. In addition, some App Engine headers, which contain job-specific information, are also be sent to the job handler.",
"type": "object"
},
"httpMethod": {
@@ -491,7 +496,7 @@
"type": "string"
},
"instance": {
"description": "App instance. By default, the job is sent to an instance which is available when the job is attempted. Requests can only be sent to a specific instance if [manual scaling is used in App Engine Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes). App Engine Flex does not support instances. For more information, see [App Engine Standard request routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed) and [App Engine Flex request routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).",
"description": "App instance. By default, the job is sent to an instance which is available when the job is attempted. Requests can only be sent to a specific instance if [manual scaling is used in App Engine Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?#scaling_types_and_instance_classes). App Engine Flex does not support instances. For more information, see [App Engine Standard request routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed) and [App Engine Flex request routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).",
"type": "string"
},
"service": {
@@ -524,7 +529,7 @@
"additionalProperties": {
"type": "string"
},
"description": "The user can specify HTTP request headers to send with the job's HTTP request. This map contains the header field names and values. Repeated headers are not supported, but a header value can contain commas. These headers represent a subset of the headers that will accompany the job's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is below: - Host: This will be computed by Cloud Scheduler and derived from uri. * `Content-Length`: This will be computed by Cloud Scheduler. * `User-Agent`: This will be set to `\"Google-Cloud-Scheduler\"`. * `X-Google-*`: Google internal use only. * `X-AppEngine-*`: Google internal use only. The total size of headers must be less than 80KB.",
"description": "The user can specify HTTP request headers to send with the job's HTTP request. This map contains the header field names and values. Repeated headers are not supported, but a header value can contain commas. These headers represent a subset of the headers that will accompany the job's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is below: - Host: This will be computed by Cloud Scheduler and derived from uri. * `Content-Length`: This will be computed by Cloud Scheduler. * `User-Agent`: This will be set to `\"Google-Cloud-Scheduler\"`. * `X-Google-*`: Google internal use only. * `X-AppEngine-*`: Google internal use only. * `X-CloudScheduler`: This header will be set to true. * `X-CloudScheduler-JobName`: This header will contain the job name. * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule time in RFC3339 UTC \"Zulu\" format. The total size of headers must be less than 80KB.",
"type": "object"
},
"httpMethod": {
@@ -567,7 +572,7 @@
"type": "object"
},
"Job": {
"description": "Configuration for a job. The maximum allowed size for a job is 100KB.",
"description": "Configuration for a job. The maximum allowed size for a job is 1MB.",
"id": "Job",
"properties": {
"appEngineHttpTarget": {
@@ -575,7 +580,7 @@
"description": "App Engine HTTP target."
},
"attemptDeadline": {
"description": "The deadline for job attempts. If the request handler does not respond by this deadline then the request is cancelled and the attempt is marked as a `DEADLINE_EXCEEDED` failure. The failed attempt can be viewed in execution logs. Cloud Scheduler will retry the job according to the RetryConfig. The allowed duration for this deadline is: * For HTTP targets, between 15 seconds and 30 minutes. * For App Engine HTTP targets, between 15 seconds and 24 hours. * For PubSub targets, this field is ignored.",
"description": "The deadline for job attempts. If the request handler does not respond by this deadline then the request is cancelled and the attempt is marked as a `DEADLINE_EXCEEDED` failure. The failed attempt can be viewed in execution logs. Cloud Scheduler will retry the job according to the RetryConfig. The allowed duration for this deadline is: * For HTTP targets, between 15 seconds and 30 minutes. * For App Engine HTTP targets, between 15 seconds and 24 hours 15 seconds. * For Pub/Sub targets, this field is ignored.",
"format": "google-duration",
"type": "string"
},
@@ -609,7 +614,7 @@
"description": "Settings that determine the retry behavior."
},
"schedule": {
"description": "Required, except when used with UpdateJob. Describes the schedule on which the job will be executed. The schedule can be either of the following types: * [Crontab](http://en.wikipedia.org/wiki/Cron#Overview) * English-like [schedule](https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules) As a general rule, execution `n + 1` of a job will not begin until execution `n` has finished. Cloud Scheduler will never allow two simultaneously outstanding executions. For example, this implies that if the `n+1`th execution is scheduled to run at 16:00 but the `n`th execution takes until 16:15, the `n+1`th execution will not start until `16:15`. A scheduled start time will be delayed if the previous execution has not ended when its scheduled time occurs. If retry_count > 0 and a job attempt fails, the job will be tried a total of retry_count times, with exponential backoff, until the next scheduled start time.",
"description": "Required, except when used with UpdateJob. Describes the schedule on which the job will be executed. The schedule can be either of the following types: * [Crontab](https://en.wikipedia.org/wiki/Cron#Overview) * English-like [schedule](https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules) As a general rule, execution `n + 1` of a job will not begin until execution `n` has finished. Cloud Scheduler will never allow two simultaneously outstanding executions. For example, this implies that if the `n+1`th execution is scheduled to run at 16:00 but the `n`th execution takes until 16:15, the `n+1`th execution will not start until `16:15`. A scheduled start time will be delayed if the previous execution has not ended when its scheduled time occurs. If retry_count > 0 and a job attempt fails, the job will be tried a total of retry_count times, with exponential backoff, until the next scheduled start time.",
"type": "string"
},
"scheduleTime": {
@@ -806,7 +811,7 @@
"type": "string"
},
"topicName": {
"description": "Required. The name of the Cloud Pub/Sub topic to which messages will be published when a job is delivered. The topic name must be in the same format as required by PubSub's [PublishRequest.name](https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#publishrequest), for example `projects/PROJECT_ID/topics/TOPIC_ID`. The topic must be in the same project as the Cloud Scheduler job.",
"description": "Required. The name of the Cloud Pub/Sub topic to which messages will be published when a job is delivered. The topic name must be in the same format as required by Pub/Sub's [PublishRequest.name](https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#publishrequest), for example `projects/PROJECT_ID/topics/TOPIC_ID`. The topic must be in the same project as the Cloud Scheduler job.",
"type": "string"
}
},

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

File diff suppressed because it is too large Load Diff

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

@@ -3,7 +3,7 @@
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "See, edit, configure, and delete your Google Cloud Platform data"
"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
}
}
}
@@ -374,7 +374,7 @@
}
}
},
"revision": "20210326",
"revision": "20220301",
"rootUrl": "https://cloudshell.googleapis.com/",
"schemas": {
"AddPublicKeyMetadata": {

1421
etc/api/cloudsupport/v2beta/cloudsupport-api.json Normal file
View File

File diff suppressed because it is too large Load Diff

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

@@ -3,7 +3,7 @@
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "View and manage your data across Google Cloud Platform services"
"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
}
}
}
@@ -156,7 +156,7 @@
"type": "string"
},
"pageSize": {
"description": "The maximum number of results to return. If not set, the service will select a default.",
"description": "The maximum number of results to return. If not set, the service selects a default.",
"format": "int32",
"location": "query",
"type": "integer"
@@ -685,7 +685,7 @@
}
}
},
"revision": "20210315",
"revision": "20220212",
"rootUrl": "https://cloudtasks.googleapis.com/",
"schemas": {
"AppEngineHttpRequest": {
@@ -789,22 +789,22 @@
"type": "object"
},
"Binding": {
"description": "Associates `members` with a `role`.",
"description": "Associates `members`, or principals, with a `role`.",
"id": "Binding",
"properties": {
"condition": {
"$ref": "Expr",
"description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)."
"description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)."
},
"members": {
"description": "Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ",
"description": "Specifies the principals requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ",
"items": {
"type": "string"
},
"type": "array"
},
"role": {
"description": "Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.",
"description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.",
"type": "string"
}
},
@@ -880,7 +880,7 @@
"id": "GetPolicyOptions",
"properties": {
"requestedPolicyVersion": {
"description": "Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
"format": "int32",
"type": "integer"
}
@@ -900,7 +900,7 @@
"additionalProperties": {
"type": "string"
},
"description": "HTTP request headers. This map contains the header field names and values. Headers can be set when the task is created. These headers represent a subset of the headers that will accompany the task's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is: * Host: This will be computed by Cloud Tasks and derived from HttpRequest.url. * Content-Length: This will be computed by Cloud Tasks. * User-Agent: This will be set to `\"Google-Cloud-Tasks\"`. * X-Google-*: Google use only. * X-AppEngine-*: Google use only. `Content-Type` won't be set by Cloud Tasks. You can explicitly set `Content-Type` to a media type when the task is created. For example, `Content-Type` can be set to `\"application/octet-stream\"` or `\"application/json\"`. Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values. The size of the headers must be less than 80KB.",
"description": "HTTP request headers. This map contains the header field names and values. Headers can be set when the task is created. These headers represent a subset of the headers that will accompany the task's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is: * Host: This will be computed by Cloud Tasks and derived from HttpRequest.url. * Content-Length: This will be computed by Cloud Tasks. * User-Agent: This will be set to `\"Google-Cloud-Tasks\"`. * `X-Google-*`: Google use only. * `X-AppEngine-*`: Google use only. `Content-Type` won't be set by Cloud Tasks. You can explicitly set `Content-Type` to a media type when the task is created. For example, `Content-Type` can be set to `\"application/octet-stream\"` or `\"application/json\"`. Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values. The size of the headers must be less than 80KB.",
"type": "object"
},
"httpMethod": {
@@ -1067,11 +1067,11 @@
"type": "object"
},
"Policy": {
"description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).",
"description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).",
"id": "Policy",
"properties": {
"bindings": {
"description": "Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.",
"description": "Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.",
"items": {
"$ref": "Binding"
},
@@ -1126,7 +1126,7 @@
"description": "Configuration options for writing logs to [Stackdriver Logging](https://cloud.google.com/logging/docs/). If this field is unset, then no logs are written."
},
"state": {
"description": "Output only. The state of the queue. `state` can only be changed by called PauseQueue, ResumeQueue, or uploading [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref). UpdateQueue cannot be used to change `state`.",
"description": "Output only. The state of the queue. `state` can only be changed by calling PauseQueue, ResumeQueue, or uploading [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref). UpdateQueue cannot be used to change `state`.",
"enum": [
"STATE_UNSPECIFIED",
"RUNNING",

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

@@ -3,7 +3,7 @@
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "View and manage your data across Google Cloud Platform services"
"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
}
}
}
@@ -156,7 +156,7 @@
"type": "string"
},
"pageSize": {
"description": "The maximum number of results to return. If not set, the service will select a default.",
"description": "The maximum number of results to return. If not set, the service selects a default.",
"format": "int32",
"location": "query",
"type": "integer"
@@ -809,7 +809,7 @@
}
}
},
"revision": "20210315",
"revision": "20220212",
"rootUrl": "https://cloudtasks.googleapis.com/",
"schemas": {
"AcknowledgeTaskRequest": {
@@ -932,22 +932,22 @@
"type": "object"
},
"Binding": {
"description": "Associates `members` with a `role`.",
"description": "Associates `members`, or principals, with a `role`.",
"id": "Binding",
"properties": {
"condition": {
"$ref": "Expr",
"description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)."
"description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)."
},
"members": {
"description": "Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ",
"description": "Specifies the principals requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ",
"items": {
"type": "string"
},
"type": "array"
},
"role": {
"description": "Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.",
"description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.",
"type": "string"
}
},
@@ -1049,7 +1049,7 @@
"id": "GetPolicyOptions",
"properties": {
"requestedPolicyVersion": {
"description": "Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
"format": "int32",
"type": "integer"
}
@@ -1200,11 +1200,11 @@
"type": "object"
},
"Policy": {
"description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).",
"description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).",
"id": "Policy",
"properties": {
"bindings": {
"description": "Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.",
"description": "Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.",
"items": {
"$ref": "Binding"
},

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

@@ -3,7 +3,7 @@
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "View and manage your data across Google Cloud Platform services"
"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
}
}
}
@@ -156,7 +156,7 @@
"type": "string"
},
"pageSize": {
"description": "The maximum number of results to return. If not set, the service will select a default.",
"description": "The maximum number of results to return. If not set, the service selects a default.",
"format": "int32",
"location": "query",
"type": "integer"
@@ -697,7 +697,7 @@
}
}
},
"revision": "20210315",
"revision": "20220212",
"rootUrl": "https://cloudtasks.googleapis.com/",
"schemas": {
"AppEngineHttpQueue": {
@@ -812,22 +812,22 @@
"type": "object"
},
"Binding": {
"description": "Associates `members` with a `role`.",
"description": "Associates `members`, or principals, with a `role`.",
"id": "Binding",
"properties": {
"condition": {
"$ref": "Expr",
"description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)."
"description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)."
},
"members": {
"description": "Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ",
"description": "Specifies the principals requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ",
"items": {
"type": "string"
},
"type": "array"
},
"role": {
"description": "Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.",
"description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.",
"type": "string"
}
},
@@ -903,7 +903,7 @@
"id": "GetPolicyOptions",
"properties": {
"requestedPolicyVersion": {
"description": "Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
"format": "int32",
"type": "integer"
}
@@ -923,7 +923,7 @@
"additionalProperties": {
"type": "string"
},
"description": "HTTP request headers. This map contains the header field names and values. Headers can be set when the task is created. These headers represent a subset of the headers that will accompany the task's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is: * Host: This will be computed by Cloud Tasks and derived from HttpRequest.url. * Content-Length: This will be computed by Cloud Tasks. * User-Agent: This will be set to `\"Google-Cloud-Tasks\"`. * X-Google-*: Google use only. * X-AppEngine-*: Google use only. `Content-Type` won't be set by Cloud Tasks. You can explicitly set `Content-Type` to a media type when the task is created. For example, `Content-Type` can be set to `\"application/octet-stream\"` or `\"application/json\"`. Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values. The size of the headers must be less than 80KB.",
"description": "HTTP request headers. This map contains the header field names and values. Headers can be set when the task is created. These headers represent a subset of the headers that will accompany the task's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is: * Host: This will be computed by Cloud Tasks and derived from HttpRequest.url. * Content-Length: This will be computed by Cloud Tasks. * User-Agent: This will be set to `\"Google-Cloud-Tasks\"`. * `X-Google-*`: Google use only. * `X-AppEngine-*`: Google use only. `Content-Type` won't be set by Cloud Tasks. You can explicitly set `Content-Type` to a media type when the task is created. For example, `Content-Type` can be set to `\"application/octet-stream\"` or `\"application/json\"`. Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values. The size of the headers must be less than 80KB.",
"type": "object"
},
"httpMethod": {
@@ -1090,11 +1090,11 @@
"type": "object"
},
"Policy": {
"description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).",
"description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).",
"id": "Policy",
"properties": {
"bindings": {
"description": "Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.",
"description": "Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.",
"items": {
"$ref": "Binding"
},

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

@@ -3,7 +3,7 @@
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "View and manage your data across Google Cloud Platform services"
"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
},
"https://www.googleapis.com/auth/trace.append": {
"description": "Write Trace data for a project or application"
@@ -18,7 +18,7 @@
"baseUrl": "https://cloudtrace.googleapis.com/",
"batchPath": "batch",
"canonicalName": "Cloud Trace",
"description": "Sends application trace data to Cloud Trace for viewing. Trace data is collected for all App Engine applications by default. Trace data from other applications can be provided using this API. This library is used to interact with the Cloud Trace API directly. If you are looking to instrument your application for Cloud Trace, we recommend using OpenCensus. ",
"description": "Sends application trace data to Cloud Trace for viewing. Trace data is collected for all App Engine applications by default. Trace data from other applications can be provided using this API. This library is used to interact with the Cloud Trace API directly. If you are looking to instrument your application for Cloud Trace, we recommend using OpenTelemetry. ",
"discoveryVersion": "v1",
"documentationLink": "https://cloud.google.com/trace",
"fullyEncodeReservedExpansion": true,
@@ -178,7 +178,7 @@
]
},
"list": {
"description": "Returns of a list of traces that match the specified filter conditions.",
"description": "Returns a list of traces that match the specified filter conditions.",
"flatPath": "v1/projects/{projectId}/traces",
"httpMethod": "GET",
"id": "cloudtrace.projects.traces.list",
@@ -257,7 +257,7 @@
}
}
},
"revision": "20210319",
"revision": "20220224",
"rootUrl": "https://cloudtrace.googleapis.com/",
"schemas": {
"Empty": {

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

@@ -3,7 +3,7 @@
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "View and manage your data across Google Cloud Platform services"
"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
},
"https://www.googleapis.com/auth/trace.append": {
"description": "Write Trace data for a project or application"
@@ -15,7 +15,7 @@
"baseUrl": "https://cloudtrace.googleapis.com/",
"batchPath": "batch",
"canonicalName": "Cloud Trace",
"description": "Sends application trace data to Cloud Trace for viewing. Trace data is collected for all App Engine applications by default. Trace data from other applications can be provided using this API. This library is used to interact with the Cloud Trace API directly. If you are looking to instrument your application for Cloud Trace, we recommend using OpenCensus. ",
"description": "Sends application trace data to Cloud Trace for viewing. Trace data is collected for all App Engine applications by default. Trace data from other applications can be provided using this API. This library is used to interact with the Cloud Trace API directly. If you are looking to instrument your application for Cloud Trace, we recommend using OpenTelemetry. ",
"discoveryVersion": "v1",
"documentationLink": "https://cloud.google.com/trace",
"fullyEncodeReservedExpansion": true,
@@ -113,7 +113,7 @@
"traces": {
"methods": {
"batchWrite": {
"description": "Sends new spans to new or existing traces. You cannot update existing spans.",
"description": "Batch writes new spans to new or existing traces. You cannot update existing spans.",
"flatPath": "v2/projects/{projectsId}/traces:batchWrite",
"httpMethod": "POST",
"id": "cloudtrace.projects.traces.batchWrite",
@@ -155,7 +155,7 @@
],
"parameters": {
"name": {
"description": "Required. The resource name of the span in the following format: projects/[PROJECT_ID]/traces/[TRACE_ID]/spans/SPAN_ID is a unique identifier for a trace within a project; it is a 32-character hexadecimal encoding of a 16-byte array. [SPAN_ID] is a unique identifier for a span within a trace; it is a 16-character hexadecimal encoding of an 8-byte array. It should not be zero.",
"description": "Required. The resource name of the span in the following format: * `projects/[PROJECT_ID]/traces/[TRACE_ID]/spans/[SPAN_ID]` `[TRACE_ID]` is a unique identifier for a trace within a project; it is a 32-character hexadecimal encoding of a 16-byte array. It should not be zero. `[SPAN_ID]` is a unique identifier for a span within a trace; it is a 16-character hexadecimal encoding of an 8-byte array. It should not be zero. .",
"location": "path",
"pattern": "^projects/[^/]+/traces/[^/]+/spans/[^/]+$",
"required": true,
@@ -181,7 +181,7 @@
}
}
},
"revision": "20210319",
"revision": "20220224",
"rootUrl": "https://cloudtrace.googleapis.com/",
"schemas": {
"Annotation": {
@@ -200,7 +200,7 @@
"type": "object"
},
"AttributeValue": {
"description": "The allowed types for [VALUE] in a `[KEY]:[VALUE]` attribute.",
"description": "The allowed types for `[VALUE]` in a `[KEY]:[VALUE]` attribute.",
"id": "AttributeValue",
"properties": {
"boolValue": {
@@ -220,14 +220,14 @@
"type": "object"
},
"Attributes": {
"description": "A set of attributes, each in the format `[KEY]:[VALUE]`.",
"description": "A set of attributes as key-value pairs.",
"id": "Attributes",
"properties": {
"attributeMap": {
"additionalProperties": {
"$ref": "AttributeValue"
},
"description": "The set of attributes. Each attribute's key can be up to 128 bytes long. The value can be a string up to 256 bytes, a signed 64-bit integer, or the Boolean values `true` and `false`. For example: \"/instance_id\": { \"string_value\": { \"value\": \"my-instance\" } } \"/http/request_bytes\": { \"int_value\": 300 } \"abc.com/myattribute\": { \"bool_value\": false }",
"description": "A set of attributes. Each attribute's key can be up to 128 bytes long. The value can be a string up to 256 bytes, a signed 64-bit integer, or the boolean values `true` or `false`. For example: \"/instance_id\": { \"string_value\": { \"value\": \"my-instance\" } } \"/http/request_bytes\": { \"int_value\": 300 } \"abc.com/myattribute\": { \"bool_value\": false }",
"type": "object"
},
"droppedAttributesCount": {
@@ -243,7 +243,7 @@
"id": "BatchWriteSpansRequest",
"properties": {
"spans": {
"description": "Required. A list of new spans. The span names must not match existing spans, or the results are undefined.",
"description": "Required. A list of new spans. The span names must not match existing spans, otherwise the results are undefined.",
"items": {
"$ref": "Span"
},
@@ -264,14 +264,14 @@
"properties": {
"attributes": {
"$ref": "Attributes",
"description": "A set of attributes on the link. You have have up to 32 attributes per link."
"description": "A set of attributes on the link. Up to 32 attributes can be specified per link."
},
"spanId": {
"description": "The [SPAN_ID] for a span within a trace.",
"description": "The `[SPAN_ID]` for a span within a trace.",
"type": "string"
},
"traceId": {
"description": "The [TRACE_ID] for a trace within a project.",
"description": "The `[TRACE_ID]` for a trace within a project.",
"type": "string"
},
"type": {
@@ -315,12 +315,12 @@
"id": "MessageEvent",
"properties": {
"compressedSizeBytes": {
"description": "The number of compressed bytes sent or received. If missing assumed to be the same size as uncompressed.",
"description": "The number of compressed bytes sent or received. If missing, the compressed size is assumed to be the same size as the uncompressed size.",
"format": "int64",
"type": "string"
},
"id": {
"description": "An identifier for the MessageEvent's message that can be used to match SENT and RECEIVED MessageEvents. It is recommended to be unique within a Span.",
"description": "An identifier for the MessageEvent's message that can be used to match `SENT` and `RECEIVED` MessageEvents.",
"format": "int64",
"type": "string"
},
@@ -362,7 +362,7 @@
"type": "object"
},
"Span": {
"description": "A span represents a single operation within a trace. Spans can be nested to form a trace tree. Often, a trace contains a root span that describes the end-to-end latency, and one or more subspans for its sub-operations. A trace can also contain multiple root spans, or none at all. Spans do not need to be contiguous\u2014there may be gaps or overlaps between spans in a trace.",
"description": "A span represents a single operation within a trace. Spans can be nested to form a trace tree. Often, a trace contains a root span that describes the end-to-end latency, and one or more subspans for its sub-operations. A trace can also contain multiple root spans, or none at all. Spans do not need to be contiguous\u2014there might be gaps or overlaps between spans in a trace.",
"id": "Span",
"properties": {
"attributes": {
@@ -376,7 +376,7 @@
},
"displayName": {
"$ref": "TruncatableString",
"description": "Required. A description of the span's operation (up to 128 bytes). Trace displays the description in the Google Cloud Platform Console. For example, the display name can be a qualified method name or a file name and a line number where the operation is called. A best practice is to use the same display name within an application and at the same call point. This makes it easier to correlate spans in different traces."
"description": "Required. A description of the span's operation (up to 128 bytes). Cloud Trace displays the description in the Cloud Console. For example, the display name can be a qualified method name or a file name and a line number where the operation is called. A best practice is to use the same display name within an application and at the same call point. This makes it easier to correlate spans in different traces."
},
"endTime": {
"description": "Required. The end time of the span. On the client side, this is the time kept by the local machine where the span execution ends. On the server side, this is the time when the server application handler stops running.",
@@ -388,11 +388,11 @@
"description": "Links associated with the span. You can have up to 128 links per Span."
},
"name": {
"description": "Required. The resource name of the span in the following format: projects/[PROJECT_ID]/traces/[TRACE_ID]/spans/SPAN_ID is a unique identifier for a trace within a project; it is a 32-character hexadecimal encoding of a 16-byte array. [SPAN_ID] is a unique identifier for a span within a trace; it is a 16-character hexadecimal encoding of an 8-byte array. It should not be zero.",
"description": "Required. The resource name of the span in the following format: * `projects/[PROJECT_ID]/traces/[TRACE_ID]/spans/[SPAN_ID]` `[TRACE_ID]` is a unique identifier for a trace within a project; it is a 32-character hexadecimal encoding of a 16-byte array. It should not be zero. `[SPAN_ID]` is a unique identifier for a span within a trace; it is a 16-character hexadecimal encoding of an 8-byte array. It should not be zero. .",
"type": "string"
},
"parentSpanId": {
"description": "The [SPAN_ID] of this span's parent span. If this is a root span, then this field must be empty.",
"description": "The `[SPAN_ID]` of this span's parent span. If this is a root span, then this field must be empty.",
"type": "string"
},
"sameProcessAsParentSpan": {
@@ -400,7 +400,7 @@
"type": "boolean"
},
"spanId": {
"description": "Required. The [SPAN_ID] portion of the span's resource name.",
"description": "Required. The `[SPAN_ID]` portion of the span's resource name.",
"type": "string"
},
"spanKind": {

18
etc/api/cloudtrace/v2beta1/cloudtrace-api.json
View File

@@ -3,7 +3,7 @@
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "View and manage your data across Google Cloud Platform services"
"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
},
"https://www.googleapis.com/auth/trace.append": {
"description": "Write Trace data for a project or application"
@@ -18,7 +18,7 @@
"baseUrl": "https://cloudtrace.googleapis.com/",
"batchPath": "batch",
"canonicalName": "Cloud Trace",
"description": "Sends application trace data to Cloud Trace for viewing. Trace data is collected for all App Engine applications by default. Trace data from other applications can be provided using this API. This library is used to interact with the Cloud Trace API directly. If you are looking to instrument your application for Cloud Trace, we recommend using OpenCensus. ",
"description": "Sends application trace data to Cloud Trace for viewing. Trace data is collected for all App Engine applications by default. Trace data from other applications can be provided using this API. This library is used to interact with the Cloud Trace API directly. If you are looking to instrument your application for Cloud Trace, we recommend using OpenTelemetry. ",
"discoveryVersion": "v1",
"documentationLink": "https://cloud.google.com/trace",
"fullyEncodeReservedExpansion": true,
@@ -206,13 +206,13 @@
],
"parameters": {
"pageSize": {
"description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of `nextPageToken` in the response indicates that more results might be available.",
"description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of `next_page_token` in the response indicates that more results might be available.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. `pageToken` must be the value of `nextPageToken` from the previous response. The values of other method parameters should be identical to those in the previous call.",
"description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of other method parameters should be identical to those in the previous call.",
"location": "query",
"type": "string"
},
@@ -250,7 +250,7 @@
"type": "string"
},
"updateMask": {
"description": "Required. Field mask that specifies the fields in `trace_sink` that are to be updated. A sink field is overwritten if, and only if, it is in the update mask. `name` and `writer_identity` fields cannot be updated. An empty updateMask is considered an error. For a detailed `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask Example: `updateMask=output_config`.",
"description": "Required. Field mask that specifies the fields in `trace_sink` that are to be updated. A sink field is overwritten if, and only if, it is in the update mask. `name` and `writer_identity` fields cannot be updated. An empty `update_mask` is considered an error. For a detailed `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask Example: `updateMask=output_config`.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
@@ -273,7 +273,7 @@
}
}
},
"revision": "20210319",
"revision": "20220224",
"rootUrl": "https://cloudtrace.googleapis.com/",
"schemas": {
"Empty": {
@@ -287,7 +287,7 @@
"id": "ListTraceSinksResponse",
"properties": {
"nextPageToken": {
"description": "If there might be more results than appear in this response, then `nextPageToken` is included. To get the next set of results, call the same method again using the value of `nextPageToken` as `pageToken`.",
"description": "A paginated response where more pages might be available has `next_page_token` set. To get the next set of results, call the same method again using the value of `next_page_token` as `page_token`.",
"type": "string"
},
"sinks": {
@@ -316,7 +316,7 @@
"id": "TraceSink",
"properties": {
"name": {
"description": "Required. The canonical sink resource name, unique within the project. Must be of the form: project/[PROJECT_NUMBER]/traceSinks/[SINK_ID]. E.g.: `\"projects/12345/traceSinks/my-project-trace-sink\"`. Sink identifiers are limited to 256 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods.",
"description": "Required. The canonical sink resource name, unique within the project. Must be of the form: projects/[PROJECT_NUMBER]/traceSinks/[SINK_ID]. E.g.: `\"projects/12345/traceSinks/my-project-trace-sink\"`. Sink identifiers are limited to 256 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods.",
"type": "string"
},
"outputConfig": {
@@ -324,7 +324,7 @@
"description": "Required. The export destination."
},
"writerIdentity": {
"description": "Output only. A service account name for exporting the data. This field is set by sinks.create and sinks.update. The service account will need to be granted write access to the destination specified in the output configuration, see [Granting access for a resource](/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). To create tables and write data this account will need the dataEditor role. Read more about roles in the [BigQuery documentation](https://cloud.google.com/bigquery/docs/access-control). E.g.: \"service-00000001@00000002.iam.gserviceaccount.com\"",
"description": "Output only. A service account name for exporting the data. This field is set by sinks.create and sinks.update. The service account will need to be granted write access to the destination specified in the output configuration, see [Granting access for a resource](/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). To create tables and to write data, this account needs the `dataEditor` role. Read more about roles in the [BigQuery documentation](https://cloud.google.com/bigquery/docs/access-control). E.g.: \"service-00000001@00000002.iam.gserviceaccount.com\"",
"readOnly": true,
"type": "string"
}

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

File diff suppressed because one or more lines are too long

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

File diff suppressed because one or more lines are too long

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