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

Merge branch 'update-apis'

Browse Source
This commit is contained in:
Sebastian Thiel
2024-03-05 21:07:11 +01:00
parent b74056b4b7 1216fcf695
commit ef8dc60e71
3510 changed files with 696963 additions and 202010 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
Makefile
View File

@@ -68,7 +68,7 @@ $(VENV_BIN):
touch $@
$(PYTHON_BIN): $(VENV_BIN) requirements.txt
python3 -m virtualenv -p python3 $(VENV_DIR)
python3 -m venv $(VENV_DIR)
$@ -m pip install -r requirements.txt
$(MAKO_RENDER): $(PYTHON_BIN) $(wildcard $(GEN_LIB_SRC)/*)

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

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

0
etc/api/abusiveexperiencereport/v1/crates/5.0.4-api+20240207 Normal file
View File

0
etc/api/abusiveexperiencereport/v1/crates/5.0.4-cli+20240207 Normal file
View File

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

@@ -115,7 +115,7 @@
}
}
},
"revision": "20230123",
"revision": "20240303",
"rootUrl": "https://acceleratedmobilepageurl.googleapis.com/",
"schemas": {
"AmpUrl": {
@@ -151,6 +151,14 @@
"URL_IS_VALID_AMP",
"URL_IS_INVALID_AMP"
],
"enumDeprecated": [
false,
false,
false,
false,
true,
false
],
"enumDescriptions": [
"Not specified error.",
"Indicates the requested URL is not found in the index, possibly because it's unable to be found, not able to be accessed by Googlebot, or some other error.",

0
etc/api/acceleratedmobilepageurl/v1/crates/5.0.4-api+20240303 Normal file
View File

0
etc/api/acceleratedmobilepageurl/v1/crates/5.0.4-cli+20240303 Normal file
View File

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

@@ -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/cloud-provider-access-management/access-approval/docs",
"documentationLink": "https://cloud.google.com/assured-workloads/access-approval/docs",
"fullyEncodeReservedExpansion": true,
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
@@ -913,7 +913,7 @@
}
}
},
"revision": "20230120",
"revision": "20240223",
"rootUrl": "https://accessapproval.googleapis.com/",
"schemas": {
"AccessApprovalServiceAccount": {
@@ -971,6 +971,19 @@
"type": "string"
},
"type": "array"
},
"notificationPubsubTopic": {
"description": "Optional. A pubsub topic to which notifications relating to approval requests should be sent.",
"type": "string"
},
"preferNoBroadApprovalRequests": {
"description": "This preference is communicated to Google personnel when sending an approval request but can be overridden if necessary.",
"type": "boolean"
},
"preferredRequestExpirationDays": {
"description": "This preference is shared with Google personnel, but can be overridden if said personnel deems necessary. The approver ultimately can set the expiration at approval time.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
@@ -1005,7 +1018,8 @@
"GOOGLE_INITIATED_SERVICE",
"GOOGLE_INITIATED_REVIEW",
"THIRD_PARTY_DATA_REQUEST",
"GOOGLE_RESPONSE_TO_PRODUCTION_ALERT"
"GOOGLE_RESPONSE_TO_PRODUCTION_ALERT",
"CLOUD_INITIATED_ACCESS"
],
"enumDescriptions": [
"Default value for proto, shouldn't be used.",
@@ -1013,7 +1027,8 @@
"The principal accessed customer data in order to diagnose or resolve a suspected issue in services. Often this access is used to confirm that customers are not affected by a suspected service issue or to remediate a reversible system issue.",
"Google initiated service for security, fraud, abuse, or compliance purposes.",
"The principal was compelled to access customer data in order to respond to a legal third party data request or process, including legal processes from customers themselves.",
"The principal accessed customer data in order to diagnose or resolve a suspected issue in services or a known outage."
"The principal accessed customer data in order to diagnose or resolve a suspected issue in services or a known outage.",
"Similar to 'GOOGLE_INITIATED_SERVICE' or 'GOOGLE_INITIATED_REVIEW', but with universe agnostic naming. The principal accessed customer data in order to diagnose or resolve a suspected issue in services or a known outage, or for security, fraud, abuse, or compliance review purposes."
],
"type": "string"
}
@@ -1041,8 +1056,13 @@
"format": "google-datetime",
"type": "string"
},
"requestedDuration": {
"description": "The requested access duration.",
"format": "google-duration",
"type": "string"
},
"requestedExpiration": {
"description": "The requested expiration for the approval. If the request is approved, access will be granted from the time of approval until the expiration time.",
"description": "The original requested expiration for the approval. Calculated by adding the requested_duration to the request_time.",
"format": "google-datetime",
"type": "string"
},
@@ -1140,7 +1160,7 @@
"id": "EnrolledService",
"properties": {
"cloudProduct": {
"description": "The product for which Access Approval will be enrolled. Allowed values are listed below (case-sensitive): * all * GA * App Engine . * Artifact Registry * BigQuery * Cloud Bigtable * Cloud Key Management Service * Compute Engine * Cloud Dataflow * Cloud Dataproc * 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 * Secret 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 * artifactregistry.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 * dataproc.googleapis.com * dlp.googleapis.com * iam.googleapis.com * logging.googleapis.com * orgpolicy.googleapis.com * pubsub.googleapis.com * spanner.googleapis.com * secretmanager.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",
"description": "The product for which Access Approval will be enrolled. Allowed values are listed below (case-sensitive): * all * GA * App Engine * Artifact Registry * BigQuery * Certificate Authority Service * Cloud Bigtable * Cloud Key Management Service * Compute Engine * Cloud Composer * Cloud Dataflow * Cloud Dataproc * Cloud DLP * Cloud EKM * Cloud Firestore * Cloud HSM * Cloud Identity and Access Management * Cloud Logging * Cloud NAT * Cloud Pub/Sub * Cloud Spanner * Cloud SQL * Cloud Storage * Eventarc * Google Kubernetes Engine * Organization Policy Serivice * Persistent Disk * Resource Manager * Secret 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 * artifactregistry.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 * dataproc.googleapis.com * dlp.googleapis.com * iam.googleapis.com * logging.googleapis.com * orgpolicy.googleapis.com * pubsub.googleapis.com * spanner.googleapis.com * secretmanager.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": {
@@ -1201,10 +1221,93 @@
"description": "The resource name of the customer CryptoKeyVersion used for signing.",
"type": "string"
},
"googleKeyAlgorithm": {
"description": "The hashing algorithm used for signature verification. It will only be present in the case of Google managed keys.",
"enum": [
"CRYPTO_KEY_VERSION_ALGORITHM_UNSPECIFIED",
"GOOGLE_SYMMETRIC_ENCRYPTION",
"AES_128_GCM",
"AES_256_GCM",
"AES_128_CBC",
"AES_256_CBC",
"AES_128_CTR",
"AES_256_CTR",
"RSA_SIGN_PSS_2048_SHA256",
"RSA_SIGN_PSS_3072_SHA256",
"RSA_SIGN_PSS_4096_SHA256",
"RSA_SIGN_PSS_4096_SHA512",
"RSA_SIGN_PKCS1_2048_SHA256",
"RSA_SIGN_PKCS1_3072_SHA256",
"RSA_SIGN_PKCS1_4096_SHA256",
"RSA_SIGN_PKCS1_4096_SHA512",
"RSA_SIGN_RAW_PKCS1_2048",
"RSA_SIGN_RAW_PKCS1_3072",
"RSA_SIGN_RAW_PKCS1_4096",
"RSA_DECRYPT_OAEP_2048_SHA256",
"RSA_DECRYPT_OAEP_3072_SHA256",
"RSA_DECRYPT_OAEP_4096_SHA256",
"RSA_DECRYPT_OAEP_4096_SHA512",
"RSA_DECRYPT_OAEP_2048_SHA1",
"RSA_DECRYPT_OAEP_3072_SHA1",
"RSA_DECRYPT_OAEP_4096_SHA1",
"EC_SIGN_P256_SHA256",
"EC_SIGN_P384_SHA384",
"EC_SIGN_SECP256K1_SHA256",
"HMAC_SHA256",
"HMAC_SHA1",
"HMAC_SHA384",
"HMAC_SHA512",
"HMAC_SHA224",
"EXTERNAL_SYMMETRIC_ENCRYPTION"
],
"enumDescriptions": [
"Not specified.",
"Creates symmetric encryption keys.",
"AES-GCM (Galois Counter Mode) using 128-bit keys.",
"AES-GCM (Galois Counter Mode) using 256-bit keys.",
"AES-CBC (Cipher Block Chaining Mode) using 128-bit keys.",
"AES-CBC (Cipher Block Chaining Mode) using 256-bit keys.",
"AES-CTR (Counter Mode) using 128-bit keys.",
"AES-CTR (Counter Mode) using 256-bit keys.",
"RSASSA-PSS 2048 bit key with a SHA256 digest.",
"RSASSA-PSS 3072 bit key with a SHA256 digest.",
"RSASSA-PSS 4096 bit key with a SHA256 digest.",
"RSASSA-PSS 4096 bit key with a SHA512 digest.",
"RSASSA-PKCS1-v1_5 with a 2048 bit key and a SHA256 digest.",
"RSASSA-PKCS1-v1_5 with a 3072 bit key and a SHA256 digest.",
"RSASSA-PKCS1-v1_5 with a 4096 bit key and a SHA256 digest.",
"RSASSA-PKCS1-v1_5 with a 4096 bit key and a SHA512 digest.",
"RSASSA-PKCS1-v1_5 signing without encoding, with a 2048 bit key.",
"RSASSA-PKCS1-v1_5 signing without encoding, with a 3072 bit key.",
"RSASSA-PKCS1-v1_5 signing without encoding, with a 4096 bit key.",
"RSAES-OAEP 2048 bit key with a SHA256 digest.",
"RSAES-OAEP 3072 bit key with a SHA256 digest.",
"RSAES-OAEP 4096 bit key with a SHA256 digest.",
"RSAES-OAEP 4096 bit key with a SHA512 digest.",
"RSAES-OAEP 2048 bit key with a SHA1 digest.",
"RSAES-OAEP 3072 bit key with a SHA1 digest.",
"RSAES-OAEP 4096 bit key with a SHA1 digest.",
"ECDSA on the NIST P-256 curve with a SHA256 digest. Other hash functions can also be used: https://cloud.google.com/kms/docs/create-validate-signatures#ecdsa_support_for_other_hash_algorithms",
"ECDSA on the NIST P-384 curve with a SHA384 digest. Other hash functions can also be used: https://cloud.google.com/kms/docs/create-validate-signatures#ecdsa_support_for_other_hash_algorithms",
"ECDSA on the non-NIST secp256k1 curve. This curve is only supported for HSM protection level. Other hash functions can also be used: https://cloud.google.com/kms/docs/create-validate-signatures#ecdsa_support_for_other_hash_algorithms",
"HMAC-SHA256 signing with a 256 bit key.",
"HMAC-SHA1 signing with a 160 bit key.",
"HMAC-SHA384 signing with a 384 bit key.",
"HMAC-SHA512 signing with a 512 bit key.",
"HMAC-SHA224 signing with a 224 bit key.",
"Algorithm representing symmetric encryption by an external key manager."
],
"type": "string"
},
"googlePublicKeyPem": {
"description": "The public key for the Google default signing, encoded in PEM format. The signature was created using a private key which may be verified using this public key.",
"type": "string"
},
"serializedApprovalRequest": {
"description": "The ApprovalRequest that is serialized without the SignatureInfo message field. This data is used with the hashing algorithm to generate the digital signature, and it can be used for signature verification.",
"format": "byte",
"type": "string"
},
"signature": {
"description": "The digital signature.",
"format": "byte",

0
etc/api/accessapproval/v1/crates/5.0.4-api+20240223 Normal file
View File

0
etc/api/accessapproval/v1/crates/5.0.4-cli+20240223 Normal file
View File

0
etc/api/accessapproval/v1beta1/crates/5.0.4-api+20200708 Normal file
View File

0
etc/api/accessapproval/v1beta1/crates/5.0.4-cli+20200708 Normal file
View File

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

@@ -12,7 +12,7 @@
"baseUrl": "https://accesscontextmanager.googleapis.com/",
"batchPath": "batch",
"canonicalName": "Access Context Manager",
"description": "An API for setting attribute based access control to requests to GCP services.",
"description": "An API for setting attribute based access control to requests to Google Cloud services. *Warning:* Do not mix *v1alpha* and *v1* API usage in the same access policy. The v1alpha API supports new Access Context Manager features, which may have different attributes or behaviors that are not supported by v1. The practice of mixed API usage within a policy may result in the inability to update that policy, including any access levels or service perimeters belonging to it. It is not recommended to use both v1 and v1alpha for modifying policies with critical service perimeters. Modifications using v1alpha should be limited to policies with non-production/non-critical service perimeters.",
"discoveryVersion": "v1",
"documentationLink": "https://cloud.google.com/access-context-manager/docs/reference/rest/",
"fullyEncodeReservedExpansion": true,
@@ -568,7 +568,7 @@
"authorizedOrgsDescs": {
"methods": {
"create": {
"description": "Creates a authorized orgs desc. The long-running operation from this RPC has a successful status after the authorized orgs desc propagates to long-lasting storage. If a authorized orgs desc contains errors, an error response is returned for the first error encountered. The name of this `AuthorizedOrgsDesc` will be assigned during creation.",
"description": "Creates an authorized orgs desc. The long-running operation from this RPC has a successful status after the authorized orgs desc propagates to long-lasting storage. If a authorized orgs desc contains errors, an error response is returned for the first error encountered. The name of this `AuthorizedOrgsDesc` will be assigned during creation.",
"flatPath": "v1/accessPolicies/{accessPoliciesId}/authorizedOrgsDescs",
"httpMethod": "POST",
"id": "accesscontextmanager.accessPolicies.authorizedOrgsDescs.create",
@@ -596,7 +596,7 @@
]
},
"delete": {
"description": "Deletes a authorized orgs desc based on the resource name. The long-running operation from this RPC has a successful status after the authorized orgs desc is removed from long-lasting storage.",
"description": "Deletes an authorized orgs desc based on the resource name. The long-running operation from this RPC has a successful status after the authorized orgs desc is removed from long-lasting storage.",
"flatPath": "v1/accessPolicies/{accessPoliciesId}/authorizedOrgsDescs/{authorizedOrgsDescsId}",
"httpMethod": "DELETE",
"id": "accesscontextmanager.accessPolicies.authorizedOrgsDescs.delete",
@@ -621,7 +621,7 @@
]
},
"get": {
"description": "Gets a authorized orgs desc based on the resource name.",
"description": "Gets an authorized orgs desc based on the resource name.",
"flatPath": "v1/accessPolicies/{accessPoliciesId}/authorizedOrgsDescs/{authorizedOrgsDescsId}",
"httpMethod": "GET",
"id": "accesscontextmanager.accessPolicies.authorizedOrgsDescs.get",
@@ -682,7 +682,7 @@
]
},
"patch": {
"description": "Updates a authorized orgs desc. The long-running operation from this RPC has a successful status after the authorized orgs desc propagates to long-lasting storage. If a authorized orgs desc contains errors, an error response is returned for the first error encountered. Only the organization list in `AuthorizedOrgsDesc` can be updated. The name, authorization_type, asset_type and authorization_direction cannot be updated.",
"description": "Updates an authorized orgs desc. The long-running operation from this RPC has a successful status after the authorized orgs desc propagates to long-lasting storage. If a authorized orgs desc contains errors, an error response is returned for the first error encountered. Only the organization list in `AuthorizedOrgsDesc` can be updated. The name, authorization_type, asset_type and authorization_direction cannot be updated.",
"flatPath": "v1/accessPolicies/{accessPoliciesId}/authorizedOrgsDescs/{authorizedOrgsDescsId}",
"httpMethod": "PATCH",
"id": "accesscontextmanager.accessPolicies.authorizedOrgsDescs.patch",
@@ -691,7 +691,7 @@
],
"parameters": {
"name": {
"description": "Assigned by the server during creation. The last segment has an arbitrary length and has only URI unreserved characters (as defined by [RFC 3986 Section 2.3](https://tools.ietf.org/html/rfc3986#section-2.3)). Should not be specified by the client during creation. Example: \"accessPolicies/122256/authorizedOrgs/b3-BhcX_Ud5N\"",
"description": "Resource name for the `AuthorizedOrgsDesc`. Format: `accessPolicies/{access_policy}/authorizedOrgsDescs/{authorized_orgs_desc}`. The `authorized_orgs_desc` component must begin with a letter, followed by alphanumeric characters or `_`. After you create an `AuthorizedOrgsDesc`, you cannot change its `name`.",
"location": "path",
"pattern": "^accessPolicies/[^/]+/authorizedOrgsDescs/[^/]+$",
"required": true,
@@ -1036,7 +1036,7 @@
]
},
"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.",
"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
"flatPath": "v1/operations",
"httpMethod": "GET",
"id": "accesscontextmanager.operations.list",
@@ -1213,7 +1213,7 @@
"type": "string"
},
"updateMask": {
"description": "Required. Only the fields specified in this mask are updated. Because name and group_key cannot be changed, update_mask is required and must always be: update_mask { paths: \"access_levels\" }",
"description": "Required. Only the fields specified in this mask are updated. Because name and group_key cannot be changed, update_mask is required and may only contain the following fields: `access_levels`, `dry_run_access_levels`. update_mask { paths: \"access_levels\" }",
"format": "google-fieldmask",
"location": "query",
"type": "string"
@@ -1233,9 +1233,64 @@
}
}
}
},
"services": {
"methods": {
"get": {
"description": "Returns a VPC-SC supported service based on the service name.",
"flatPath": "v1/services/{name}",
"httpMethod": "GET",
"id": "accesscontextmanager.services.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the service to get information about. The names must be in the same format as used in defining a service perimeter, for example, `storage.googleapis.com`.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "v1/services/{name}",
"response": {
"$ref": "SupportedService"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists all VPC-SC supported services.",
"flatPath": "v1/services",
"httpMethod": "GET",
"id": "accesscontextmanager.services.list",
"parameterOrder": [],
"parameters": {
"pageSize": {
"description": "This flag specifies the maximum number of services to return per page. Default is 100.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Token to start on a later page. Default is the first page.",
"location": "query",
"type": "string"
}
},
"path": "v1/services",
"response": {
"$ref": "ListSupportedServicesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
},
"revision": "20230123",
"revision": "20240226",
"rootUrl": "https://accesscontextmanager.googleapis.com/",
"schemas": {
"AccessContextManagerOperationMetadata": {
@@ -1288,7 +1343,7 @@
"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}`",
"description": "The scopes of the AccessPolicy. Scopes define which resources a policy can restrict and where its resources can be referenced. For example, policy A with `scopes=[\"folders/123\"]` has the following behavior: - ServicePerimeter can only restrict projects within `folders/123`. - ServicePerimeter within policy A can only reference access levels defined within policy A. - Only one policy can include a given scope; thus, attempting to create a second policy which includes `folders/123` will result in an error. If no scopes are provided, then any resource within the organization can be restricted. Scopes cannot be modified after a policy is created. Policies can only have a single scope. Format: list of `folders/{folder_number}` or `projects/{project_number}`",
"items": {
"type": "string"
},
@@ -1368,11 +1423,11 @@
"type": "object"
},
"AuthorizedOrgsDesc": {
"description": "`AuthorizedOrgsDesc` is a resource that contains a list of organizations for a authorization type and asset type and its authorization direction.",
"description": "`AuthorizedOrgsDesc` contains data for an organization's authorization policy.",
"id": "AuthorizedOrgsDesc",
"properties": {
"assetType": {
"description": "The asset type of this authorized orgs desc. e.g. device, credential strength.",
"description": "The asset type of this authorized orgs desc. Valid values are `ASSET_TYPE_DEVICE`, and `ASSET_TYPE_CREDENTIAL_STRENGTH`.",
"enum": [
"ASSET_TYPE_UNSPECIFIED",
"ASSET_TYPE_DEVICE",
@@ -1381,12 +1436,12 @@
"enumDescriptions": [
"No asset type specified.",
"Device asset type.",
"credential strength asset type."
"Credential strength asset type."
],
"type": "string"
},
"authorizationDirection": {
"description": "Authorization direction of this authorization relationship. i.e. Whether to allow specified orgs to evaluate this org's traffic, or allow specified orgs' traffic to be evaluated by this org. Orgs specified as `AUTHORIZATION_DIRECTION_TO` in this AuthorizedOrgsDesc[com.google.identity.accesscontextmanager.v1.AuthorizedOrgsDesc] must also specify this org as the `AUTHORIZATION_DIRECTION_FROM` in their own AuthorizedOrgsDesc in order for this relationship to take effect. Orgs specified as `AUTHORIZATION_DIRECTION_FROM` in this AuthorizedOrgsDesc[com.google.identity.accesscontextmanager.v1.AuthorizedOrgsDesc] must also specify this org as the `AUTHORIZATION_DIRECTION_TO` in their own AuthorizedOrgsDesc in order for this relationship to take effect.",
"description": "The direction of the authorization relationship between this organization and the organizations listed in the `orgs` field. The valid values for this field include the following: `AUTHORIZATION_DIRECTION_FROM`: Allows this organization to evaluate traffic in the organizations listed in the `orgs` field. `AUTHORIZATION_DIRECTION_TO`: Allows the organizations listed in the `orgs` field to evaluate the traffic in this organization. For the authorization relationship to take effect, all of the organizations must authorize and specify the appropriate relationship direction. For example, if organization A authorized organization B and C to evaluate its traffic, by specifying `AUTHORIZATION_DIRECTION_TO` as the authorization direction, organizations B and C must specify `AUTHORIZATION_DIRECTION_FROM` as the authorization direction in their `AuthorizedOrgsDesc` resource.",
"enum": [
"AUTHORIZATION_DIRECTION_UNSPECIFIED",
"AUTHORIZATION_DIRECTION_TO",
@@ -1394,13 +1449,13 @@
],
"enumDescriptions": [
"No direction specified.",
"Specified orgs will evaluate traffic.",
"Specified orgs' traffic will be evaluated."
"The specified organizations are authorized to evaluate traffic in this organization.",
"The traffic of the specified organizations can be evaluated by this organization."
],
"type": "string"
},
"authorizationType": {
"description": "The authorization type of this authorized orgs desc. e.g.authorization, troubleshooting or logging.",
"description": "A granular control type for authorization levels. Valid value is `AUTHORIZATION_TYPE_TRUST`.",
"enum": [
"AUTHORIZATION_TYPE_UNSPECIFIED",
"AUTHORIZATION_TYPE_TRUST"
@@ -1412,11 +1467,11 @@
"type": "string"
},
"name": {
"description": "Assigned by the server during creation. The last segment has an arbitrary length and has only URI unreserved characters (as defined by [RFC 3986 Section 2.3](https://tools.ietf.org/html/rfc3986#section-2.3)). Should not be specified by the client during creation. Example: \"accessPolicies/122256/authorizedOrgs/b3-BhcX_Ud5N\"",
"description": "Resource name for the `AuthorizedOrgsDesc`. Format: `accessPolicies/{access_policy}/authorizedOrgsDescs/{authorized_orgs_desc}`. The `authorized_orgs_desc` component must begin with a letter, followed by alphanumeric characters or `_`. After you create an `AuthorizedOrgsDesc`, you cannot change its `name`.",
"type": "string"
},
"orgs": {
"description": "The list of organization ids in this AuthorizedOrgsDesc.",
"description": "The list of organization ids in this AuthorizedOrgsDesc. Format: `organizations/` Example: `organizations/123456`",
"items": {
"type": "string"
},
@@ -1460,14 +1515,14 @@
"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 Google Cloud 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. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `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 Google Cloud 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. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `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. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.",
"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`.",
"description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).",
"type": "string"
}
},
@@ -1527,7 +1582,7 @@
"type": "array"
},
"negate": {
"description": "Whether to negate the Condition. If true, the Condition becomes a NAND over its non-empty fields, each field must be false for the Condition overall to be satisfied. Defaults to false.",
"description": "Whether to negate the Condition. If true, the Condition becomes a NAND over its non-empty fields. Any non-empty field criteria evaluating to false will result in the Condition to be satisfied. Defaults to false.",
"type": "boolean"
},
"regions": {
@@ -1543,6 +1598,13 @@
"type": "string"
},
"type": "array"
},
"vpcNetworkSources": {
"description": "The request must originate from one of the provided VPC networks in Google Cloud. Cannot specify this field together with `ip_subnetworks`.",
"items": {
"$ref": "VpcNetworkSource"
},
"type": "array"
}
},
"type": "object"
@@ -1627,7 +1689,7 @@
"id": "EgressFrom",
"properties": {
"identities": {
"description": "A list of identities that are allowed access through this [EgressPolicy]. Should be in the format of email address. The email address should represent individual user or service account only.",
"description": "A list of identities that are allowed access through this [EgressPolicy], in the format of `user:{email_id}` or `serviceAccount:{email_id}`.",
"items": {
"type": "string"
},
@@ -1648,6 +1710,27 @@
"Authorize access from all service accounts outside the perimeter."
],
"type": "string"
},
"sourceRestriction": {
"description": "Whether to enforce traffic restrictions based on `sources` field. If the `sources` fields is non-empty, then this field must be set to `SOURCE_RESTRICTION_ENABLED`.",
"enum": [
"SOURCE_RESTRICTION_UNSPECIFIED",
"SOURCE_RESTRICTION_ENABLED",
"SOURCE_RESTRICTION_DISABLED"
],
"enumDescriptions": [
"Enforcement preference unspecified, will not enforce traffic restrictions based on `sources` in EgressFrom.",
"Enforcement preference enabled, traffic restrictions will be enforced based on `sources` in EgressFrom.",
"Enforcement preference disabled, will not enforce traffic restrictions based on `sources` in EgressFrom."
],
"type": "string"
},
"sources": {
"description": "Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`.",
"items": {
"$ref": "EgressSource"
},
"type": "array"
}
},
"type": "object"
@@ -1667,6 +1750,17 @@
},
"type": "object"
},
"EgressSource": {
"description": "The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries.",
"id": "EgressSource",
"properties": {
"accessLevel": {
"description": "An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through 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 EgressSources will be allowed.",
"type": "string"
}
},
"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 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",
@@ -1729,7 +1823,14 @@
"id": "GcpUserAccessBinding",
"properties": {
"accessLevels": {
"description": "Required. Access level that a user must have to be granted access. Only one access level is supported, not multiple. This repeated field must have exactly one element. Example: \"accessPolicies/9522/accessLevels/device_trusted\"",
"description": "Optional. Access level that a user must have to be granted access. Only one access level is supported, not multiple. This repeated field must have exactly one element. Example: \"accessPolicies/9522/accessLevels/device_trusted\"",
"items": {
"type": "string"
},
"type": "array"
},
"dryRunAccessLevels": {
"description": "Optional. Dry run access level that will be evaluated but will not be enforced. The access denial based on dry run policy will be logged. Only one access level is supported, not multiple. This list must have exactly one element. Example: \"accessPolicies/9522/accessLevels/device_trusted\"",
"items": {
"type": "string"
},
@@ -1747,7 +1848,7 @@
"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.",
"description": "Metadata of GCP Access Binding Long Running Operations.",
"id": "GcpUserAccessBindingOperationMetadata",
"properties": {},
"type": "object"
@@ -1780,7 +1881,7 @@
"id": "IngressFrom",
"properties": {
"identities": {
"description": "A list of identities that are allowed access through this ingress policy. Should be in the format of email address. The email address should represent individual user or service account only.",
"description": "A list of identities that are allowed access through this ingress policy, in the format of `user:{email_id}` or `serviceAccount:{email_id}`.",
"items": {
"type": "string"
},
@@ -1836,7 +1937,7 @@
"type": "string"
},
"resource": {
"description": "A Google Cloud resource that is allowed to ingress the perimeter. Requests from these resources will be allowed to access perimeter data. Currently only projects and VPCs are allowed. Project format: `projects/{project_number}` VPC format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/networks/{NAME}`. The project may be in any Google Cloud organization, not just the organization that the perimeter is defined in. `*` is not allowed, the case of allowing all Google Cloud resources only is not supported.",
"description": "A Google Cloud resource that is allowed to ingress the perimeter. Requests from these resources will be allowed to access perimeter data. Currently only projects and VPCs are allowed. Project format: `projects/{project_number}` VPC network format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/networks/{NAME}`. The project may be in any Google Cloud organization, not just the organization that the perimeter is defined in. `*` is not allowed, the case of allowing all Google Cloud resources only is not supported.",
"type": "string"
}
},
@@ -1904,7 +2005,7 @@
"id": "ListAuthorizedOrgsDescsResponse",
"properties": {
"authorizedOrgsDescs": {
"description": "List of the Authorized Orgs Desc instances.",
"description": "List of all the Authorized Orgs Desc instances.",
"items": {
"$ref": "AuthorizedOrgsDesc"
},
@@ -1971,16 +2072,34 @@
},
"type": "object"
},
"ListSupportedServicesResponse": {
"description": "A response to `ListSupportedServicesRequest`.",
"id": "ListSupportedServicesResponse",
"properties": {
"nextPageToken": {
"description": "The pagination token to retrieve the next page of results. If the value is empty, no further results remain.",
"type": "string"
},
"supportedServices": {
"description": "List of services supported by VPC Service Controls instances.",
"items": {
"$ref": "SupportedService"
},
"type": "array"
}
},
"type": "object"
},
"MethodSelector": {
"description": "An allowed method or permission of a service specified in ApiOperation.",
"id": "MethodSelector",
"properties": {
"method": {
"description": "Value for `method` should be a valid method name for the corresponding `service_name` in ApiOperation. If `*` used as value for `method`, then ALL methods and permissions are allowed.",
"description": "A valid method name for the corresponding `service_name` in ApiOperation. If `*` is used as the value for the `method`, then ALL methods and permissions are allowed.",
"type": "string"
},
"permission": {
"description": "Value for `permission` should be a valid Cloud IAM permission for the corresponding `service_name` in ApiOperation.",
"description": "A valid Cloud IAM permission for the corresponding `service_name` in ApiOperation.",
"type": "string"
}
},
@@ -2015,7 +2134,7 @@
"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`.",
"description": "The normal, successful response of the operation. 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"
}
},
@@ -2059,7 +2178,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`, 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/).",
"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": {
@@ -2154,7 +2273,7 @@
"type": "object"
},
"ServicePerimeter": {
"description": "`ServicePerimeter` describes a set of Google Cloud resources which can freely import and export data amongst themselves, but not export outside of the `ServicePerimeter`. If a request with a source within this `ServicePerimeter` has a target outside of the `ServicePerimeter`, the request will be blocked. Otherwise the request is allowed. There are two types of Service Perimeter - Regular and Bridge. Regular Service Perimeters cannot overlap, a single Google Cloud project can only belong to a single regular Service Perimeter. Service Perimeter Bridges can contain only Google Cloud projects as members, a single Google Cloud project may belong to multiple Service Perimeter Bridges.",
"description": "`ServicePerimeter` describes a set of Google Cloud resources which can freely import and export data amongst themselves, but not export outside of the `ServicePerimeter`. If a request with a source within this `ServicePerimeter` has a target outside of the `ServicePerimeter`, the request will be blocked. Otherwise the request is allowed. There are two types of Service Perimeter - Regular and Bridge. Regular Service Perimeters cannot overlap, a single Google Cloud project or VPC network can only belong to a single regular Service Perimeter. Service Perimeter Bridges can contain only Google Cloud projects as members, a single Google Cloud project may belong to multiple Service Perimeter Bridges.",
"id": "ServicePerimeter",
"properties": {
"description": {
@@ -2166,7 +2285,7 @@
"type": "string"
},
"perimeterType": {
"description": "Perimeter type indicator. A single project is allowed to be a member of single regular perimeter, but multiple service perimeter bridges. A project cannot be a included in a perimeter bridge without being included in regular perimeter. For perimeter bridges, the restricted service list as well as access level lists must be empty.",
"description": "Perimeter type indicator. A single project or VPC network is allowed to be a member of single regular perimeter, but multiple service perimeter bridges. A project cannot be a included in a perimeter bridge without being included in regular perimeter. For perimeter bridges, the restricted service list as well as access level lists must be empty.",
"enum": [
"PERIMETER_TYPE_REGULAR",
"PERIMETER_TYPE_BRIDGE"
@@ -2222,7 +2341,7 @@
"type": "array"
},
"resources": {
"description": "A list of Google Cloud resources that are inside of the service perimeter. Currently only projects and VPCs are allowed. Project format: `projects/{project_number}` VPC format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/networks/{NAME}`.",
"description": "A list of Google Cloud resources that are inside of the service perimeter. Currently only projects and VPCs are allowed. Project format: `projects/{project_number}` VPC network format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/networks/{NAME}`.",
"items": {
"type": "string"
},
@@ -2285,6 +2404,60 @@
},
"type": "object"
},
"SupportedService": {
"description": "`SupportedService` specifies the VPC Service Controls and its properties.",
"id": "SupportedService",
"properties": {
"availableOnRestrictedVip": {
"description": "True if the service is available on the restricted VIP. Services on the restricted VIP typically either support VPC Service Controls or are core infrastructure services required for the functioning of Google Cloud.",
"type": "boolean"
},
"knownLimitations": {
"description": "True if the service is supported with some limitations. Check [documentation](https://cloud.google.com/vpc-service-controls/docs/supported-products) for details.",
"type": "boolean"
},
"name": {
"description": "The service name or address of the supported service, such as `service.googleapis.com`.",
"type": "string"
},
"supportStage": {
"description": "The support stage of the service.",
"enum": [
"LAUNCH_STAGE_UNSPECIFIED",
"UNIMPLEMENTED",
"PRELAUNCH",
"EARLY_ACCESS",
"ALPHA",
"BETA",
"GA",
"DEPRECATED"
],
"enumDescriptions": [
"Do not use this default value.",
"The feature is not yet implemented. Users can not use it.",
"Prelaunch features are hidden from users and are only visible internally.",
"Early Access features are limited to a closed group of testers. To use these features, you must sign up in advance and sign a Trusted Tester agreement (which includes confidentiality provisions). These features may be unstable, changed in backward-incompatible ways, and are not guaranteed to be released.",
"Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects allowlisted. Alpha releases don't have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases.",
"Beta is the point at which we are ready to open a release for any customer to use. There are no SLA or technical support obligations in a Beta release. Products will be complete from a feature perspective, but may have some open outstanding issues. Beta releases are suitable for limited production use cases.",
"GA features are open to all developers and are considered stable and fully qualified for production use.",
"Deprecated features are scheduled to be shut down and removed. For more information, see the \"Deprecation Policy\" section of our [Terms of Service](https://cloud.google.com/terms/) and the [Google Cloud Platform Subject to the Deprecation Policy](https://cloud.google.com/terms/deprecation) documentation."
],
"type": "string"
},
"supportedMethods": {
"description": "The list of the supported methods. This field exists only in response to GetSupportedService",
"items": {
"$ref": "MethodSelector"
},
"type": "array"
},
"title": {
"description": "The name of the supported product, such as 'Cloud Product API'.",
"type": "string"
}
},
"type": "object"
},
"TestIamPermissionsRequest": {
"description": "Request message for `TestIamPermissions` method.",
"id": "TestIamPermissionsRequest",
@@ -2330,6 +2503,35 @@
}
},
"type": "object"
},
"VpcNetworkSource": {
"description": "The originating network source in Google Cloud.",
"id": "VpcNetworkSource",
"properties": {
"vpcSubnetwork": {
"$ref": "VpcSubNetwork",
"description": "Sub-segment ranges of a VPC network."
}
},
"type": "object"
},
"VpcSubNetwork": {
"description": "Sub-segment ranges inside of a VPC Network.",
"id": "VpcSubNetwork",
"properties": {
"network": {
"description": "Required. Network name. If the network is not part of the organization, the `compute.network.get` permission must be granted to the caller. Format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/networks/{NETWORK_NAME}` Example: `//compute.googleapis.com/projects/my-project/global/networks/network-1`",
"type": "string"
},
"vpcIpSubnetworks": {
"description": "CIDR block IP subnetwork specification. The IP address must be an IPv4 address and can be a public or private IP address. Note that for a CIDR IP address block, the specified IP address portion must be properly truncated (i.e. all the host bits must be zero) or the input is considered malformed. For example, \"192.0.2.0/24\" is accepted but \"192.0.2.1/24\" is not. If empty, all IP addresses are allowed.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
},
"servicePath": "",

0
etc/api/accesscontextmanager/v1/crates/5.0.4-api+20240226 Normal file
View File

0
etc/api/accesscontextmanager/v1/crates/5.0.4-cli+20240226 Normal file
View File

0
etc/api/accesscontextmanager/v1beta/crates/5.0.4-api+20230123 Normal file
View File

0
etc/api/accesscontextmanager/v1beta/crates/5.0.4-cli+20230123 Normal file
View File

0
etc/api/adexchangebuyer/v1.3/crates/5.0.4-api+20210330 Normal file
View File

0
etc/api/adexchangebuyer/v1.4/crates/5.0.4-api+20210330 Normal file
View File

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

@@ -2566,9 +2566,556 @@
}
}
}
},
"buyers": {
"resources": {
"filterSets": {
"methods": {
"create": {
"description": "Creates the specified filter set for the account with the given account ID.",
"flatPath": "v2beta1/buyers/{buyersId}/filterSets",
"httpMethod": "POST",
"id": "adexchangebuyer2.buyers.filterSets.create",
"parameterOrder": [
"ownerName"
],
"parameters": {
"isTransient": {
"description": "Whether the filter set is transient, or should be persisted indefinitely. By default, filter sets are not transient. If transient, it will be available for at least 1 hour after creation.",
"location": "query",
"type": "boolean"
},
"ownerName": {
"description": "Name of the owner (bidder or account) of the filter set to be created. For example: - For a bidder-level filter set for bidder 123: `bidders/123` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456`",
"location": "path",
"pattern": "^buyers/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2beta1/{+ownerName}/filterSets",
"request": {
"$ref": "FilterSet"
},
"response": {
"$ref": "FilterSet"
},
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
]
},
"delete": {
"description": "Deletes the requested filter set from the account with the given account ID.",
"flatPath": "v2beta1/buyers/{buyersId}/filterSets/{filterSetsId}",
"httpMethod": "DELETE",
"id": "adexchangebuyer2.buyers.filterSets.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Full name of the resource to delete. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
"location": "path",
"pattern": "^buyers/[^/]+/filterSets/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2beta1/{+name}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
]
},
"get": {
"description": "Retrieves the requested filter set for the account with the given account ID.",
"flatPath": "v2beta1/buyers/{buyersId}/filterSets/{filterSetsId}",
"httpMethod": "GET",
"id": "adexchangebuyer2.buyers.filterSets.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Full name of the resource being requested. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
"location": "path",
"pattern": "^buyers/[^/]+/filterSets/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2beta1/{+name}",
"response": {
"$ref": "FilterSet"
},
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
]
},
"list": {
"description": "Lists all filter sets for the account with the given account ID.",
"flatPath": "v2beta1/buyers/{buyersId}/filterSets",
"httpMethod": "GET",
"id": "adexchangebuyer2.buyers.filterSets.list",
"parameterOrder": [
"ownerName"
],
"parameters": {
"ownerName": {
"description": "Name of the owner (bidder or account) of the filter sets to be listed. For example: - For a bidder-level filter set for bidder 123: `bidders/123` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456`",
"location": "path",
"pattern": "^buyers/[^/]+$",
"required": true,
"type": "string"
},
"pageSize": {
"description": "Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A token identifying a page of results the server should return. Typically, this is the value of ListFilterSetsResponse.nextPageToken returned from the previous call to the accounts.filterSets.list method.",
"location": "query",
"type": "string"
}
},
"path": "v2beta1/{+ownerName}/filterSets",
"response": {
"$ref": "ListFilterSetsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
]
}
},
"resources": {
"bidMetrics": {
"methods": {
"list": {
"description": "Lists all metrics that are measured in terms of number of bids.",
"flatPath": "v2beta1/buyers/{buyersId}/filterSets/{filterSetsId}/bidMetrics",
"httpMethod": "GET",
"id": "adexchangebuyer2.buyers.filterSets.bidMetrics.list",
"parameterOrder": [
"filterSetName"
],
"parameters": {
"filterSetName": {
"description": "Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
"location": "path",
"pattern": "^buyers/[^/]+/filterSets/[^/]+$",
"required": true,
"type": "string"
},
"pageSize": {
"description": "Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A token identifying a page of results the server should return. Typically, this is the value of ListBidMetricsResponse.nextPageToken returned from the previous call to the bidMetrics.list method.",
"location": "query",
"type": "string"
}
},
"path": "v2beta1/{+filterSetName}/bidMetrics",
"response": {
"$ref": "ListBidMetricsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
]
}
}
},
"bidResponseErrors": {
"methods": {
"list": {
"description": "List all errors that occurred in bid responses, with the number of bid responses affected for each reason.",
"flatPath": "v2beta1/buyers/{buyersId}/filterSets/{filterSetsId}/bidResponseErrors",
"httpMethod": "GET",
"id": "adexchangebuyer2.buyers.filterSets.bidResponseErrors.list",
"parameterOrder": [
"filterSetName"
],
"parameters": {
"filterSetName": {
"description": "Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
"location": "path",
"pattern": "^buyers/[^/]+/filterSets/[^/]+$",
"required": true,
"type": "string"
},
"pageSize": {
"description": "Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A token identifying a page of results the server should return. Typically, this is the value of ListBidResponseErrorsResponse.nextPageToken returned from the previous call to the bidResponseErrors.list method.",
"location": "query",
"type": "string"
}
},
"path": "v2beta1/{+filterSetName}/bidResponseErrors",
"response": {
"$ref": "ListBidResponseErrorsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
]
}
}
},
"bidResponsesWithoutBids": {
"methods": {
"list": {
"description": "List all reasons for which bid responses were considered to have no applicable bids, with the number of bid responses affected for each reason.",
"flatPath": "v2beta1/buyers/{buyersId}/filterSets/{filterSetsId}/bidResponsesWithoutBids",
"httpMethod": "GET",
"id": "adexchangebuyer2.buyers.filterSets.bidResponsesWithoutBids.list",
"parameterOrder": [
"filterSetName"
],
"parameters": {
"filterSetName": {
"description": "Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
"location": "path",
"pattern": "^buyers/[^/]+/filterSets/[^/]+$",
"required": true,
"type": "string"
},
"pageSize": {
"description": "Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A token identifying a page of results the server should return. Typically, this is the value of ListBidResponsesWithoutBidsResponse.nextPageToken returned from the previous call to the bidResponsesWithoutBids.list method.",
"location": "query",
"type": "string"
}
},
"path": "v2beta1/{+filterSetName}/bidResponsesWithoutBids",
"response": {
"$ref": "ListBidResponsesWithoutBidsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
]
}
}
},
"filteredBidRequests": {
"methods": {
"list": {
"description": "List all reasons that caused a bid request not to be sent for an impression, with the number of bid requests not sent for each reason.",
"flatPath": "v2beta1/buyers/{buyersId}/filterSets/{filterSetsId}/filteredBidRequests",
"httpMethod": "GET",
"id": "adexchangebuyer2.buyers.filterSets.filteredBidRequests.list",
"parameterOrder": [
"filterSetName"
],
"parameters": {
"filterSetName": {
"description": "Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
"location": "path",
"pattern": "^buyers/[^/]+/filterSets/[^/]+$",
"required": true,
"type": "string"
},
"pageSize": {
"description": "Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A token identifying a page of results the server should return. Typically, this is the value of ListFilteredBidRequestsResponse.nextPageToken returned from the previous call to the filteredBidRequests.list method.",
"location": "query",
"type": "string"
}
},
"path": "v2beta1/{+filterSetName}/filteredBidRequests",
"response": {
"$ref": "ListFilteredBidRequestsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
]
}
}
},
"filteredBids": {
"methods": {
"list": {
"description": "List all reasons for which bids were filtered, with the number of bids filtered for each reason.",
"flatPath": "v2beta1/buyers/{buyersId}/filterSets/{filterSetsId}/filteredBids",
"httpMethod": "GET",
"id": "adexchangebuyer2.buyers.filterSets.filteredBids.list",
"parameterOrder": [
"filterSetName"
],
"parameters": {
"filterSetName": {
"description": "Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
"location": "path",
"pattern": "^buyers/[^/]+/filterSets/[^/]+$",
"required": true,
"type": "string"
},
"pageSize": {
"description": "Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A token identifying a page of results the server should return. Typically, this is the value of ListFilteredBidsResponse.nextPageToken returned from the previous call to the filteredBids.list method.",
"location": "query",
"type": "string"
}
},
"path": "v2beta1/{+filterSetName}/filteredBids",
"response": {
"$ref": "ListFilteredBidsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
]
}
},
"resources": {
"creatives": {
"methods": {
"list": {
"description": "List all creatives associated with a specific reason for which bids were filtered, with the number of bids filtered for each creative.",
"flatPath": "v2beta1/buyers/{buyersId}/filterSets/{filterSetsId}/filteredBids/{creativeStatusId}/creatives",
"httpMethod": "GET",
"id": "adexchangebuyer2.buyers.filterSets.filteredBids.creatives.list",
"parameterOrder": [
"filterSetName",
"creativeStatusId"
],
"parameters": {
"creativeStatusId": {
"description": "The ID of the creative status for which to retrieve a breakdown by creative. See [creative-status-codes](https://developers.google.com/authorized-buyers/rtb/downloads/creative-status-codes).",
"format": "int32",
"location": "path",
"required": true,
"type": "integer"
},
"filterSetName": {
"description": "Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
"location": "path",
"pattern": "^buyers/[^/]+/filterSets/[^/]+$",
"required": true,
"type": "string"
},
"pageSize": {
"description": "Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A token identifying a page of results the server should return. Typically, this is the value of ListCreativeStatusBreakdownByCreativeResponse.nextPageToken returned from the previous call to the filteredBids.creatives.list method.",
"location": "query",
"type": "string"
}
},
"path": "v2beta1/{+filterSetName}/filteredBids/{creativeStatusId}/creatives",
"response": {
"$ref": "ListCreativeStatusBreakdownByCreativeResponse"
},
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
]
}
}
},
"details": {
"methods": {
"list": {
"description": "List all details associated with a specific reason for which bids were filtered, with the number of bids filtered for each detail.",
"flatPath": "v2beta1/buyers/{buyersId}/filterSets/{filterSetsId}/filteredBids/{creativeStatusId}/details",
"httpMethod": "GET",
"id": "adexchangebuyer2.buyers.filterSets.filteredBids.details.list",
"parameterOrder": [
"filterSetName",
"creativeStatusId"
],
"parameters": {
"creativeStatusId": {
"description": "The ID of the creative status for which to retrieve a breakdown by detail. See [creative-status-codes](https://developers.google.com/authorized-buyers/rtb/downloads/creative-status-codes). Details are only available for statuses 10, 14, 15, 17, 18, 19, 86, and 87.",
"format": "int32",
"location": "path",
"required": true,
"type": "integer"
},
"filterSetName": {
"description": "Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
"location": "path",
"pattern": "^buyers/[^/]+/filterSets/[^/]+$",
"required": true,
"type": "string"
},
"pageSize": {
"description": "Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A token identifying a page of results the server should return. Typically, this is the value of ListCreativeStatusBreakdownByDetailResponse.nextPageToken returned from the previous call to the filteredBids.details.list method.",
"location": "query",
"type": "string"
}
},
"path": "v2beta1/{+filterSetName}/filteredBids/{creativeStatusId}/details",
"response": {
"$ref": "ListCreativeStatusBreakdownByDetailResponse"
},
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
]
}
}
}
}
},
"impressionMetrics": {
"methods": {
"list": {
"description": "Lists all metrics that are measured in terms of number of impressions.",
"flatPath": "v2beta1/buyers/{buyersId}/filterSets/{filterSetsId}/impressionMetrics",
"httpMethod": "GET",
"id": "adexchangebuyer2.buyers.filterSets.impressionMetrics.list",
"parameterOrder": [
"filterSetName"
],
"parameters": {
"filterSetName": {
"description": "Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
"location": "path",
"pattern": "^buyers/[^/]+/filterSets/[^/]+$",
"required": true,
"type": "string"
},
"pageSize": {
"description": "Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A token identifying a page of results the server should return. Typically, this is the value of ListImpressionMetricsResponse.nextPageToken returned from the previous call to the impressionMetrics.list method.",
"location": "query",
"type": "string"
}
},
"path": "v2beta1/{+filterSetName}/impressionMetrics",
"response": {
"$ref": "ListImpressionMetricsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
]
}
}
},
"losingBids": {
"methods": {
"list": {
"description": "List all reasons for which bids lost in the auction, with the number of bids that lost for each reason.",
"flatPath": "v2beta1/buyers/{buyersId}/filterSets/{filterSetsId}/losingBids",
"httpMethod": "GET",
"id": "adexchangebuyer2.buyers.filterSets.losingBids.list",
"parameterOrder": [
"filterSetName"
],
"parameters": {
"filterSetName": {
"description": "Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
"location": "path",
"pattern": "^buyers/[^/]+/filterSets/[^/]+$",
"required": true,
"type": "string"
},
"pageSize": {
"description": "Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A token identifying a page of results the server should return. Typically, this is the value of ListLosingBidsResponse.nextPageToken returned from the previous call to the losingBids.list method.",
"location": "query",
"type": "string"
}
},
"path": "v2beta1/{+filterSetName}/losingBids",
"response": {
"$ref": "ListLosingBidsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
]
}
}
},
"nonBillableWinningBids": {
"methods": {
"list": {
"description": "List all reasons for which winning bids were not billable, with the number of bids not billed for each reason.",
"flatPath": "v2beta1/buyers/{buyersId}/filterSets/{filterSetsId}/nonBillableWinningBids",
"httpMethod": "GET",
"id": "adexchangebuyer2.buyers.filterSets.nonBillableWinningBids.list",
"parameterOrder": [
"filterSetName"
],
"parameters": {
"filterSetName": {
"description": "Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123: `bidders/123/filterSets/abc` - For an account-level filter set for the buyer account representing bidder 123: `bidders/123/accounts/123/filterSets/abc` - For an account-level filter set for the child seat buyer account 456 whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`",
"location": "path",
"pattern": "^buyers/[^/]+/filterSets/[^/]+$",
"required": true,
"type": "string"
},
"pageSize": {
"description": "Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A token identifying a page of results the server should return. Typically, this is the value of ListNonBillableWinningBidsResponse.nextPageToken returned from the previous call to the nonBillableWinningBids.list method.",
"location": "query",
"type": "string"
}
},
"path": "v2beta1/{+filterSetName}/nonBillableWinningBids",
"response": {
"$ref": "ListNonBillableWinningBidsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
]
}
}
}
}
}
}
}
},
"revision": "20230124",
"revision": "20240305",
"rootUrl": "https://adexchangebuyer.googleapis.com/",
"schemas": {
"AbsoluteDateRange": {
@@ -2732,7 +3279,7 @@
},
"billedImpressions": {
"$ref": "MetricValue",
"description": "The number of bids for which the buyer was billed."
"description": "The number of bids for which the buyer was billed. Also called valid impressions as invalid impressions are not billed."
},
"impressionsWon": {
"$ref": "MetricValue",
@@ -3109,7 +3656,8 @@
"NON_INTERSTITIAL",
"IN_BANNER_VIDEO",
"RENDERING_SIZELESS_ADX",
"OMSDK_1_0"
"OMSDK_1_0",
"RENDERING_PLAYABLE"
],
"enumDescriptions": [
"Do not use. This is a placeholder value only.",
@@ -3149,7 +3697,8 @@
"The creative has an interstitial size of non interstitial. For pretargeting.",
"The video type is in-banner video.",
"The creative can dynamically resize to fill a variety of slot sizes.",
"The open measurement SDK is supported."
"The open measurement SDK is supported.",
"The creative is considered a playable display creative."
],
"type": "string"
},
@@ -3163,6 +3712,7 @@
"type": "array"
},
"corrections": {
"deprecated": true,
"description": "Output only. Shows any corrections that were applied to this creative.",
"items": {
"$ref": "Correction"
@@ -4234,6 +4784,7 @@
"type": "string"
},
"formats": {
"deprecated": true,
"description": "Creative formats bidded on or allowed to bid on, can be empty. Although this field is a list, it can only be populated with a single item. A HTTP 400 bad request error will be returned in the response if you specify multiple items.",
"items": {
"enum": [
@@ -4349,6 +4900,7 @@
"type": "string"
},
"detailId": {
"deprecated": true,
"description": "Note: this field will be deprecated, use \"detail\" field instead. When \"detail\" field represents an integer value, this field is populated as the same integer value \"detail\" field represents, otherwise this field will be 0. The ID of the detail. The associated value can be looked up in the dictionary file corresponding to the DetailType in the response message.",
"format": "int32",
"type": "integer"
@@ -4441,7 +4993,7 @@
"type": "string"
},
"guaranteedLooks": {
"description": "Count of guaranteed looks. Required for deal, optional for product.",
"description": "Count of guaranteed looks. Required for deal, optional for product. For CPD deals, buyer changes to guaranteed_looks will be ignored.",
"format": "int64",
"type": "string"
},
@@ -4451,7 +5003,7 @@
"type": "string"
},
"minimumDailyLooks": {
"description": "Daily minimum looks for CPD deal types.",
"description": "Daily minimum looks for CPD deal types. For CPD deals, buyer should negotiate on this field instead of guaranteed_looks.",
"format": "int64",
"type": "string"
},
@@ -5079,6 +5631,7 @@
"type": "number"
},
"storeUrl": {
"deprecated": true,
"description": "The URL to the app store to purchase/download the promoted app.",
"type": "string"
},
@@ -5471,6 +6024,7 @@
"type": "boolean"
},
"isSetupComplete": {
"deprecated": true,
"description": "Output only. True, if the buyside inventory setup is complete for this proposal.",
"readOnly": true,
"type": "boolean"
@@ -5679,7 +6233,8 @@
"OPPO",
"SAMSUNG",
"VIVO",
"XIAOMI"
"XIAOMI",
"LG_TV"
],
"enumDescriptions": [
"A placeholder for an unknown app store.",
@@ -5694,7 +6249,8 @@
"OPPO App Market",
"Samsung Galaxy Store",
"VIVO App Store",
"Xiaomi GetApps"
"Xiaomi GetApps",
"LG TV"
],
"type": "string"
},
@@ -5785,6 +6341,7 @@
"type": "object"
},
"SecurityContext": {
"deprecated": true,
"description": "Output only. A security context.",
"id": "SecurityContext",
"properties": {
@@ -5854,6 +6411,7 @@
},
"securityType": {
"$ref": "SecurityContext",
"deprecated": true,
"description": "Matches impressions for a particular security type."
}
},
@@ -5875,6 +6433,7 @@
"description": "Disapproval bound to this restriction. Only present if status=DISAPPROVED. Can be used to filter the response of the creatives.list method."
},
"disapprovalReasons": {
"deprecated": true,
"description": "Any disapprovals bound to this restriction. Only present if status=DISAPPROVED. Can be used to filter the response of the creatives.list method. Deprecated; use disapproval field instead.",
"items": {
"$ref": "Disapproval"

0
etc/api/adexchangebuyer2/v2beta1/crates/5.0.4-api+20240305 Normal file
View File

0
etc/api/adexchangeseller/v2.0/crates/5.0.4-api+20171101 Normal file
View File

0
etc/api/adexchangeseller/v2.0/crates/5.0.4-cli+20171101 Normal file
View File

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

@@ -6,6 +6,7 @@
"description": "Views Ad Experience Report data, and gets a list of sites that have a significant number of annoying ads.",
"discoveryVersion": "v1",
"documentationLink": "https://developers.google.com/ad-experience-report/",
"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"
@@ -138,7 +139,7 @@
}
}
},
"revision": "20230114",
"revision": "20240207",
"rootUrl": "https://adexperiencereport.googleapis.com/",
"schemas": {
"PlatformSummary": {
@@ -153,6 +154,12 @@
"WARNING",
"FAILING"
],
"enumDeprecated": [
false,
false,
true,
false
],
"enumDescriptions": [
"Not reviewed.",
"Passing.",
@@ -190,6 +197,7 @@
"type": "string"
},
"region": {
"deprecated": true,
"description": "The site's regions on this platform. No longer populated, because there is no longer any semantic difference between sites in different regions.",
"items": {
"enum": [

0
etc/api/adexperiencereport/v1/crates/5.0.4-api+20240207 Normal file
View File

0
etc/api/adexperiencereport/v1/crates/5.0.4-cli+20240207 Normal file
View File

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

@@ -272,7 +272,7 @@
}
}
},
"revision": "20230117",
"revision": "20240227",
"rootUrl": "https://admin.googleapis.com/",
"schemas": {
"Application": {

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

@@ -305,7 +305,8 @@
"chromeosdevices": {
"methods": {
"action": {
"description": "Takes an action that affects a Chrome OS Device. This includes deprovisioning, disabling, and re-enabling devices. *Warning:* * Deprovisioning a device will stop device policy syncing and remove device-level printers. After a device is deprovisioned, it must be wiped before it can be re-enrolled. * Lost or stolen devices should use the disable action. * Re-enabling a disabled device will consume a device license. If you do not have sufficient licenses available when completing the re-enable action, you will receive an error. For more information about deprovisioning and disabling devices, visit the [help center](https://support.google.com/chrome/a/answer/3523633).",
"deprecated": true,
"description": "Use [BatchChangeChromeOsDeviceStatus](/admin-sdk/directory/reference/rest/v1/customer.devices.chromeos/batchChangeStatus) instead. Takes an action that affects a Chrome OS Device. This includes deprovisioning, disabling, and re-enabling devices. *Warning:* * Deprovisioning a device will stop device policy syncing and remove device-level printers. After a device is deprovisioned, it must be wiped before it can be re-enrolled. * Lost or stolen devices should use the disable action. * Re-enabling a disabled device will consume a device license. If you do not have sufficient licenses available when completing the re-enable action, you will receive an error. For more information about deprovisioning and disabling devices, visit the [help center](https://support.google.com/chrome/a/answer/3523633).",
"flatPath": "admin/directory/v1/customer/{customerId}/devices/chromeos/{resourceId}/action",
"httpMethod": "POST",
"id": "directory.chromeosdevices.action",
@@ -613,6 +614,33 @@
"resources": {
"chromeos": {
"methods": {
"batchChangeStatus": {
"description": "Changes the status of a batch of ChromeOS devices. For more information about changing a ChromeOS device state [Repair, repurpose, or retire ChromeOS devices](https://support.google.com/chrome/a/answer/3523633).",
"flatPath": "admin/directory/v1/customer/{customerId}/devices/chromeos:batchChangeStatus",
"httpMethod": "POST",
"id": "admin.customer.devices.chromeos.batchChangeStatus",
"parameterOrder": [
"customerId"
],
"parameters": {
"customerId": {
"description": "Required. Immutable ID of the Google Workspace account.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "admin/directory/v1/customer/{customerId}/devices/chromeos:batchChangeStatus",
"request": {
"$ref": "BatchChangeChromeOsDeviceStatusRequest"
},
"response": {
"$ref": "BatchChangeChromeOsDeviceStatusResponse"
},
"scopes": [
"https://www.googleapis.com/auth/admin.directory.device.chromeos"
]
},
"issueCommand": {
"description": "Issues a command for the device to execute.",
"flatPath": "admin/directory/v1/customer/{customerId}/devices/chromeos/{deviceId}:issueCommand",
@@ -2376,11 +2404,13 @@
"description": "Whether to return all sub-organizations or just immediate children.",
"enum": [
"all",
"children"
"children",
"allIncludingParent"
],
"enumDescriptions": [
"All sub-organizational units.",
"Immediate children only (default)."
"Immediate children only (default).",
"All sub-organizational units and the specified organizational unit (root if not specified)."
],
"location": "query",
"type": "string"
@@ -3284,6 +3314,11 @@
"required": true,
"type": "string"
},
"includeIndirectRoleAssignments": {
"description": "When set to `true`, fetches indirect role assignments (i.e. role assignment via a group) as well as direct ones. Defaults to `false`. You must specify `user_key` or the indirect role assignments will not be included.",
"location": "query",
"type": "boolean"
},
"maxResults": {
"description": "Maximum number of results to return.",
"format": "int32",
@@ -3303,7 +3338,7 @@
"type": "string"
},
"userKey": {
"description": "The user's primary email address, alias email address, or unique user ID. If included in the request, returns role assignments only for this user.",
"description": "The primary email address, alias email address, or unique user or group ID. If included in the request, returns role assignments only for this user or group.",
"location": "query",
"type": "string"
}
@@ -3896,12 +3931,18 @@
]
},
"insert": {
"description": "Creates a user.",
"description": "Creates a user. Mutate calls immediately following user creation might sometimes fail as the user isn't fully created due to propagation delay in our backends. Check the error details for the \"User creation is not complete\" message to see if this is the case. Retrying the calls after some time can help in this case.",
"flatPath": "admin/directory/v1/users",
"httpMethod": "POST",
"id": "directory.users.insert",
"parameterOrder": [],
"parameters": {},
"parameters": {
"resolveConflictAccount": {
"description": "Optional. If set to `true`, the option selected for [handling unmanaged user accounts](https://support.google.com/a/answer/11112794) will apply. Default: `false`",
"location": "query",
"type": "boolean"
}
},
"path": "admin/directory/v1/users",
"request": {
"$ref": "User"
@@ -4072,7 +4113,7 @@
]
},
"patch": {
"description": "Updates a user using patch semantics. The update method should be used instead, since it also supports patch semantics and has better performance. This method is unable to clear fields that contain repeated objects (`addresses`, `phones`, etc). Use the update method instead.",
"description": "Updates a user using patch semantics. The update method should be used instead, because it also supports patch semantics and has better performance. If you're mapping an external identity to a Google identity, use the [`update`](https://developers.google.com/admin-sdk/directory/v1/reference/users/update) method instead of the `patch` method. This method is unable to clear fields that contain repeated objects (`addresses`, `phones`, etc). Use the update method instead.",
"flatPath": "admin/directory/v1/users/{userKey}",
"httpMethod": "PATCH",
"id": "directory.users.patch",
@@ -4630,7 +4671,7 @@
}
}
},
"revision": "20230117",
"revision": "20240227",
"rootUrl": "https://admin.googleapis.com/",
"schemas": {
"Alias": {
@@ -4769,6 +4810,93 @@
},
"type": "object"
},
"BatchChangeChromeOsDeviceStatusRequest": {
"description": "A request for changing the status of a batch of ChromeOS devices.",
"id": "BatchChangeChromeOsDeviceStatusRequest",
"properties": {
"changeChromeOsDeviceStatusAction": {
"description": "Required. The action to take on the ChromeOS device in order to change its status.",
"enum": [
"CHANGE_CHROME_OS_DEVICE_STATUS_ACTION_UNSPECIFIED",
"CHANGE_CHROME_OS_DEVICE_STATUS_ACTION_DEPROVISION",
"CHANGE_CHROME_OS_DEVICE_STATUS_ACTION_DISABLE",
"CHANGE_CHROME_OS_DEVICE_STATUS_ACTION_REENABLE"
],
"enumDescriptions": [
"Default value. Value is unused.",
"Deprovisions a ChromeOS device. If you have ChromeOS devices that are no longer being used in your organization, you should deprovision them so that you\u2019re no longer managing them. Deprovisioning the device removes all policies that were on the device as well as device-level printers and the ability to use the device as a kiosk. Depending on the upgrade that\u2019s associated with the device this action might release the license back into the license pool; which allows you to use the license on a different device.",
"Disables a ChromeOS device. Use this action if a user loses their device or it\u2019s stolen, this makes it such that the device is still managed, so it will still receive policies, but no one can use it. Depending on the upgrade that\u2019s associated with the device this action might release the license back into the license pool; which allows you to use the license on a different device.",
"Reenables a ChromeOS device to be used after being disabled. Reenables the device once it's no longer lost or it's been recovered. This allows the device to be used again. Depending on the upgrade associated with the device this might consume one license from the license pool, meaning that if there aren't enough licenses available the operation will fail."
],
"type": "string"
},
"deprovisionReason": {
"description": "Optional. The reason behind a device deprovision. Must be provided if 'changeChromeOsDeviceStatusAction' is set to 'CHANGE_CHROME_OS_DEVICE_STATUS_ACTION_DEPROVISION'. Otherwise, omit this field.",
"enum": [
"DEPROVISION_REASON_UNSPECIFIED",
"DEPROVISION_REASON_SAME_MODEL_REPLACEMENT",
"DEPROVISION_REASON_UPGRADE",
"DEPROVISION_REASON_DOMAIN_MOVE",
"DEPROVISION_REASON_SERVICE_EXPIRATION",
"DEPROVISION_REASON_OTHER",
"DEPROVISION_REASON_DIFFERENT_MODEL_REPLACEMENT",
"DEPROVISION_REASON_RETIRING_DEVICE",
"DEPROVISION_REASON_UPGRADE_TRANSFER",
"DEPROVISION_REASON_NOT_REQUIRED",
"DEPROVISION_REASON_REPAIR_CENTER"
],
"enumDeprecated": [
false,
false,
true,
true,
true,
true,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"The deprovision reason is unknown.",
"Same model replacement. You have return materials authorization (RMA) or you are replacing a malfunctioning device under warranty with the same device model.",
"The device was upgraded.",
"The device's domain was changed.",
"Service expired for the device.",
"The device was deprovisioned for a legacy reason that is no longer supported.",
"Different model replacement. You are replacing this device with an upgraded or newer device model.",
"Retiring from fleet. You are donating, discarding, or otherwise removing the device from use.",
"ChromeOS Flex upgrade transfer. This is a ChromeOS Flex device that you are replacing with a Chromebook within a year.",
"A reason was not required. For example, the licenses were returned to the customer's license pool.",
"The device was deprovisioned by the Repair Service Center. Can only be set by Repair Service Center during RMA."
],
"type": "string"
},
"deviceIds": {
"description": "Required. List of the IDs of the ChromeOS devices to change. Maximum 50.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"BatchChangeChromeOsDeviceStatusResponse": {
"description": "The response of changing the status of a batch of ChromeOS devices.",
"id": "BatchChangeChromeOsDeviceStatusResponse",
"properties": {
"changeChromeOsDeviceStatusResults": {
"description": "The results for each of the ChromeOS devices provided in the request.",
"items": {
"$ref": "ChangeChromeOsDeviceStatusResult"
},
"type": "array"
}
},
"type": "object"
},
"BatchCreatePrintServersRequest": {
"description": "Request to add multiple new print servers in a batch.",
"id": "BatchCreatePrintServersRequest",
@@ -5138,6 +5266,31 @@
},
"type": "object"
},
"ChangeChromeOsDeviceStatusResult": {
"description": "The result of a single ChromeOS device for a Change state operation.",
"id": "ChangeChromeOsDeviceStatusResult",
"properties": {
"deviceId": {
"description": "The unique ID of the ChromeOS device.",
"type": "string"
},
"error": {
"$ref": "Status",
"description": "The error result of the operation in case of failure."
},
"response": {
"$ref": "ChangeChromeOsDeviceStatusSucceeded",
"description": "The device could change its status successfully."
}
},
"type": "object"
},
"ChangeChromeOsDeviceStatusSucceeded": {
"description": "Response for a successful ChromeOS device status change.",
"id": "ChangeChromeOsDeviceStatusSucceeded",
"properties": {},
"type": "object"
},
"Channel": {
"description": "An notification channel used to watch for resource changes.",
"id": "Channel",
@@ -5343,30 +5496,43 @@
"deprovisionReason": {
"description": "(Read-only) Deprovision reason.",
"enum": [
"deprovisionReasonUnspecified",
"deprovisionReasonSameModelReplacement",
"deprovisionReasonUpgrade",
"deprovisionReasonDomainMove",
"deprovisionReasonServiceExpiration",
"deprovisionReasonOther",
"deprovisionReasonDifferentModelReplacement",
"deprovisionReasonRetiringDevice",
"deprovisionReasonUpgradeTransfer",
"deprovisionReasonNotRequired",
"deprovisionReasonRepairCenter"
"DEPROVISION_REASON_UNSPECIFIED",
"DEPROVISION_REASON_SAME_MODEL_REPLACEMENT",
"DEPROVISION_REASON_UPGRADE",
"DEPROVISION_REASON_DOMAIN_MOVE",
"DEPROVISION_REASON_SERVICE_EXPIRATION",
"DEPROVISION_REASON_OTHER",
"DEPROVISION_REASON_DIFFERENT_MODEL_REPLACEMENT",
"DEPROVISION_REASON_RETIRING_DEVICE",
"DEPROVISION_REASON_UPGRADE_TRANSFER",
"DEPROVISION_REASON_NOT_REQUIRED",
"DEPROVISION_REASON_REPAIR_CENTER"
],
"enumDeprecated": [
false,
false,
true,
true,
true,
true,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"The deprovision reason is unknown.",
"Same model replacement.",
"Device upgrade.",
"Domain move.",
"Service expiration.",
"Other.",
"Different model replacement.",
"Retiring device.",
"Transferring perpetual upgrade to a new device.",
"No reason required, i.e. licenses returned to customer's license pool.",
"Deprovisioned by a RMA (service center) caller."
"Same model replacement. You have return materials authorization (RMA) or you are replacing a malfunctioning device under warranty with the same device model.",
"The device was upgraded.",
"The device's domain was changed.",
"Service expired for the device.",
"The device was deprovisioned for a legacy reason that is no longer supported.",
"Different model replacement. You are replacing this device with an upgraded or newer device model.",
"Retiring from fleet. You are donating, discarding, or otherwise removing the device from use.",
"ChromeOS Flex upgrade transfer. This is a ChromeOS Flex device that you are replacing with a Chromebook within a year.",
"A reason was not required. For example, the licenses were returned to the customer's license pool.",
"The device was deprovisioned by the Repair Service Center. Can only be set by Repair Service Center during RMA."
],
"type": "string"
},
@@ -5400,6 +5566,27 @@
"description": "The unique ID of the Chrome device.",
"type": "string"
},
"deviceLicenseType": {
"description": "Output only. Device license type.",
"enum": [
"deviceLicenseTypeUnspecified",
"enterprise",
"enterpriseUpgrade",
"educationUpgrade",
"education",
"kioskUpgrade"
],
"enumDescriptions": [
"The license type is unknown.",
"The device is bundled with a perpetual Chrome Enterprise Upgrade.",
"The device has an annual standalone Chrome Enterprise Upgrade.",
"The device has a perpetual standalone Chrome Education Upgrade.",
"The device is bundled with a perpetual Chrome Education Upgrade.",
"The device has an annual Kiosk Upgrade."
],
"readOnly": true,
"type": "string"
},
"diskVolumeReports": {
"description": "Reports of disk space and other info about mounted/connected volumes.",
"items": {
@@ -5895,7 +6082,9 @@
"SET_VOLUME",
"WIPE_USERS",
"REMOTE_POWERWASH",
"DEVICE_START_CRD_SESSION"
"DEVICE_START_CRD_SESSION",
"CAPTURE_LOGS",
"FETCH_SUPPORT_PACKET"
],
"enumDescriptions": [
"The command type was unspecified.",
@@ -5904,7 +6093,9 @@
"Set the volume of the device. Can only be issued to Kiosk and managed guest session devices.",
"Wipe all the users off of the device. Executing this command in the device will remove all user profile data, but it will keep device policy and enrollment.",
"Wipes the device by performing a power wash. Executing this command in the device will remove all data including user policies, device policies and enrollment policies. Warning: This will revert the device back to a factory state with no enrollment unless the device is subject to forced or auto enrollment. Use with caution, as this is an irreversible action!",
"Starts a Chrome Remote Desktop session."
"Starts a Chrome Remote Desktop session.",
"Capture the system logs of a kiosk device. The logs can be downloaded from the downloadUrl link present in `deviceFiles` field of [chromeosdevices](https://developers.google.com/admin-sdk/directory/reference/rest/v1/chromeosdevices)",
"Fetch support packet from a device remotely. Support packet is a zip archive that contains various system logs and debug data from a ChromeOS device. The support packet can be downloaded from the downloadURL link present in the `deviceFiles` field of [`chromeosdevices`](https://developers.google.com/admin-sdk/directory/reference/rest/v1/chromeosdevices)"
],
"type": "string"
}
@@ -5916,7 +6107,7 @@
"id": "DirectoryChromeosdevicesCommandResult",
"properties": {
"commandResultPayload": {
"description": "The payload for the command result. The following commands respond with a payload: - DEVICE_START_CRD_SESSION: Payload is a stringified JSON object in the form: { \"url\": url }. The URL provides a link to the CRD session.",
"description": "The payload for the command result. The following commands respond with a payload: * `DEVICE_START_CRD_SESSION`: Payload is a stringified JSON object in the form: { \"url\": url }. The URL provides a link to the Chrome Remote Desktop session.",
"type": "string"
},
"errorMessage": {
@@ -5960,7 +6151,9 @@
"SET_VOLUME",
"WIPE_USERS",
"REMOTE_POWERWASH",
"DEVICE_START_CRD_SESSION"
"DEVICE_START_CRD_SESSION",
"CAPTURE_LOGS",
"FETCH_SUPPORT_PACKET"
],
"enumDescriptions": [
"The command type was unspecified.",
@@ -5969,12 +6162,14 @@
"Set the volume of the device. Can only be issued to Kiosk and managed guest session devices.",
"Wipe all the users off of the device. Executing this command in the device will remove all user profile data, but it will keep device policy and enrollment.",
"Wipes the device by performing a power wash. Executing this command in the device will remove all data including user policies, device policies and enrollment policies. Warning: This will revert the device back to a factory state with no enrollment unless the device is subject to forced or auto enrollment. Use with caution, as this is an irreversible action!",
"Starts a Chrome Remote Desktop session."
"Starts a Chrome Remote Desktop session.",
"Capture the system logs of a kiosk device. The logs can be downloaded from the downloadUrl link present in `deviceFiles` field of [chromeosdevices](https://developers.google.com/admin-sdk/directory/reference/rest/v1/chromeosdevices)",
"Fetch support packet from a device remotely. Support packet is a zip archive that contains various system logs and debug data from a ChromeOS device. The support packet can be downloaded from the downloadURL link present in the `deviceFiles` field of [`chromeosdevices`](https://developers.google.com/admin-sdk/directory/reference/rest/v1/chromeosdevices)"
],
"type": "string"
},
"payload": {
"description": "The payload for the command, provide it only if command supports it. The following commands support adding payload: - SET_VOLUME: Payload is a stringified JSON object in the form: { \"volume\": 50 }. The volume has to be an integer in the range [0,100]. - DEVICE_START_CRD_SESSION: Payload is optionally a stringified JSON object in the form: { \"ackedUserPresence\": true }. ackedUserPresence is a boolean. If a device is being used, ackedUserPresence must be set to true to acknowledge that you want to start a CRD session anyways. It is false by default, so a CRD command will fail if used on an active device without this field.",
"description": "The payload for the command, provide it only if command supports it. The following commands support adding payload: * `SET_VOLUME`: Payload is a stringified JSON object in the form: { \"volume\": 50 }. The volume has to be an integer in the range [0,100]. * `DEVICE_START_CRD_SESSION`: Payload is optionally a stringified JSON object in the form: { \"ackedUserPresence\": true }. `ackedUserPresence` is a boolean. By default, `ackedUserPresence` is set to `false`. To start a Chrome Remote Desktop session for an active device, set `ackedUserPresence` to `true`. * `REBOOT`: Payload is a stringified JSON object in the form: { \"user_session_delay_seconds\": 300 }. The delay has to be in the range [0, 300]. * `FETCH_SUPPORT_PACKET`: Payload is optionally a stringified JSON object in the form: {\"supportPacketDetails\":{ \"issueCaseId\": optional_support_case_id_string, \"issueDescription\": optional_issue_description_string, \"requestedDataCollectors\": []}} The list of available `data_collector_enums` are as following: Chrome System Information (1), Crash IDs (2), Memory Details (3), UI Hierarchy (4), Additional ChromeOS Platform Logs (5), Device Event (6), Intel WiFi NICs Debug Dump (7), Touch Events (8), Lacros (9), Lacros System Information (10), ChromeOS Flex Logs (11), DBus Details (12), ChromeOS Network Routes (13), ChromeOS Shill (Connection Manager) Logs (14), Policies (15), ChromeOS System State and Logs (16), ChromeOS System Logs (17), ChromeOS Chrome User Logs (18), ChromeOS Bluetooth (19), ChromeOS Connected Input Devices (20), ChromeOS Traffic Counters (21), ChromeOS Virtual Keyboard (22), ChromeOS Network Health (23). See more details in [help article](https://support.google.com/chrome/a?p=remote-log).",
"type": "string"
}
},
@@ -6433,7 +6628,7 @@
"id": "Member",
"properties": {
"delivery_settings": {
"description": "Defines mail delivery preferences of member. This is only supported by create/update/get.",
"description": "Defines mail delivery preferences of member. This field is only supported by `insert`, `update`, and `get` methods.",
"type": "string"
},
"email": {
@@ -6761,7 +6956,8 @@
"id": "OrgUnit",
"properties": {
"blockInheritance": {
"description": "Determines if a sub-organizational unit can inherit the settings of the parent organization. The default value is `false`, meaning a sub-organizational unit inherits the settings of the nearest parent organizational unit. For more information on inheritance and users in an organization structure, see the [administration help center](https://support.google.com/a/answer/4352075).",
"deprecated": true,
"description": "Determines if a sub-organizational unit can inherit the settings of the parent organization. The default value is `false`, meaning a sub-organizational unit inherits the settings of the nearest parent organizational unit. This field is deprecated. Setting it to `true` is no longer supported and can have _unintended consequences_. For more information about inheritance and users in an organization structure, see the [administration help center](https://support.google.com/a/answer/4352075).",
"type": "boolean"
},
"description": {
@@ -7168,7 +7364,20 @@
"id": "RoleAssignment",
"properties": {
"assignedTo": {
"description": "The unique ID of the entity this role is assigned to\u2014either the `user_id` of a user or the `uniqueId` of a service account, as defined in [Identity and Access Management (IAM)](https://cloud.google.com/iam/docs/reference/rest/v1/projects.serviceAccounts).",
"description": "The unique ID of the entity this role is assigned to\u2014either the `user_id` of a user, the `group_id` of a group, or the `uniqueId` of a service account as defined in [Identity and Access Management (IAM)](https://cloud.google.com/iam/docs/reference/rest/v1/projects.serviceAccounts).",
"type": "string"
},
"assigneeType": {
"description": "Output only. The type of the assignee (`USER` or `GROUP`).",
"enum": [
"user",
"group"
],
"enumDescriptions": [
"An individual user within the domain.",
"A group within the domain."
],
"readOnly": true,
"type": "string"
},
"etag": {
@@ -7405,6 +7614,33 @@
},
"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"
},
"Token": {
"description": "JSON template for token resource in Directory API.",
"id": "Token",
@@ -7472,7 +7708,7 @@
"type": "object"
},
"User": {
"description": "The Directory API allows you to create and manage your account's users, user aliases, and user Gmail chat profile photos. For more information about common tasks, see the [User Accounts Developer's Guide](/admin-sdk/directory/v1/guides/manage-users.html) and the [User Aliases Developer's Guide](/admin-sdk/directory/v1/guides/manage-user-aliases.html).",
"description": "The Directory API allows you to create and manage your account's users, user aliases, and user Google profile photos. For more information about common tasks, see the [User Accounts Developer's Guide](/admin-sdk/directory/v1/guides/manage-users.html) and the [User Aliases Developer's Guide](/admin-sdk/directory/v1/guides/manage-user-aliases.html).",
"id": "User",
"properties": {
"addresses": {
@@ -7524,7 +7760,7 @@
"type": "string"
},
"emails": {
"description": "The list of the user's email addresses. The maximum allowed data size for this field is 10KB.",
"description": "The list of the user's email addresses. The maximum allowed data size for this field is 10KB. This excludes `publicKeyEncryptionCertificates`.",
"type": "any"
},
"etag": {
@@ -7695,7 +7931,7 @@
"type": "string"
},
"thumbnailPhotoUrl": {
"description": "Output only. Photo Url of the user (Read-only)",
"description": "Output only. The URL of the user's profile photo. The URL might be temporary or private.",
"readOnly": true,
"type": "string"
},
@@ -7831,6 +8067,24 @@
"description": "If this is user's primary email. Only one entry could be marked as primary.",
"type": "boolean"
},
"public_key_encryption_certificates": {
"description": "Public Key Encryption Certificates. Current limit: 1 per email address, and 5 per user.",
"properties": {
"certificate": {
"description": "X.509 encryption certificate in `PEM` format. Must only be an end-entity (leaf) certificate.",
"type": "string"
},
"is_default": {
"description": "Whether this is the default certificate for the given email address.",
"type": "boolean"
},
"state": {
"description": "Denotes the certificate's state in its lifecycle. Possible values are `not_yet_validated`, `valid`, `invalid`, `expired`, and `revoked`.",
"type": "string"
}
},
"type": "object"
},
"type": {
"description": "Each entry can have a type which indicates standard types of that entry. For example email could be of home, work etc. In addition to the standard type, an entry can have a custom type and can take any value Such types should have the CUSTOM value as type and also have a customType value.",
"type": "string"

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

@@ -149,7 +149,8 @@
"context_aware_access",
"chrome",
"data_studio",
"keep"
"keep",
"vault"
],
"enumDescriptions": [
"The Google Workspace Access Transparency activity reports return information about different types of Access Transparency activity events.",
@@ -172,10 +173,11 @@
"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 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."
"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.",
"The Vault activity reports return information about various types of Vault activity events."
],
"location": "path",
"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)",
"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)|(vault)",
"required": true,
"type": "string"
},
@@ -358,7 +360,8 @@
},
"orgUnitID": {
"default": "",
"description": "ID of the organizational unit to report on. Activity records will be shown only for users who belong to the specified organizational unit. Data before Dec 17, 2018 doesn't appear in the filtered results.",
"deprecated": true,
"description": "`Deprecated`. This field is deprecated and is no longer supported. ID of the organizational unit to report on. Activity records will be shown only for users who belong to the specified organizational unit. Data before Dec 17, 2018 doesn't appear in the filtered results.",
"location": "query",
"pattern": "(id:[a-z0-9]+)",
"type": "string"
@@ -431,7 +434,7 @@
"type": "string"
},
"date": {
"description": "Represents the date the usage occurred, based on PST time zone. The timestamp is in the [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601), `yyyy-mm-dd`.",
"description": "Represents the date the usage occurred, based on UTC-8:00 (Pacific Standard Time). The timestamp is in the [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601), `yyyy-mm-dd`.",
"location": "path",
"pattern": "(\\d){4}-(\\d){2}-(\\d){2}",
"required": true,
@@ -479,7 +482,7 @@
"type": "string"
},
"date": {
"description": "Represents the date the usage occurred. The timestamp is in the ISO 8601 format, yyyy-mm-dd. We recommend you use your account's time zone for this.",
"description": "Represents the date the usage occurred, based on UTC-8:00 (Pacific Standard Time). The timestamp is in the [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601), `yyyy-mm-dd`.",
"location": "path",
"pattern": "(\\d){4}-(\\d){2}-(\\d){2}",
"required": true,
@@ -560,7 +563,7 @@
"type": "string"
},
"date": {
"description": "Represents the date the usage occurred, based on GMT-7:00 (Pacific Standard Time). The timestamp is in the [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601), `yyyy-mm-dd`.",
"description": "Represents the date the usage occurred, based on UTC-8:00 (Pacific Standard Time). The timestamp is in the [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601), `yyyy-mm-dd`.",
"location": "path",
"pattern": "(\\d){4}-(\\d){2}-(\\d){2}",
"required": true,
@@ -623,7 +626,7 @@
}
}
},
"revision": "20230117",
"revision": "20240227",
"rootUrl": "https://admin.googleapis.com/",
"schemas": {
"Activities": {
@@ -688,7 +691,7 @@
"items": {
"properties": {
"name": {
"description": "Name of the event. This is the specific name of the activity reported by the API. And each `eventName` is related to a specific Google Workspace service or feature which the API organizes into types of events. For `eventName` request parameters in general: - If no `eventName` is given, the report returns all possible instances of an `eventName`. - When you request an `eventName`, the API's response returns all activities which contain that `eventName`. It is possible that the returned activities will have other `eventName` properties in addition to the one requested. For more information about `eventName` properties, see the list of event names for various applications above in `applicationName`.",
"description": "Name of the event. This is the specific name of the activity reported by the API. And each `eventName` is related to a specific Google Workspace service or feature which the API organizes into types of events. For `eventName` request parameters in general: - If no `eventName` is given, the report returns all possible instances of an `eventName`. - When you request an `eventName`, the API's response returns all activities which contain that `eventName`. For more information about `eventName` properties, see the list of event names for various applications above in `applicationName`.",
"type": "string"
},
"parameters": {
@@ -840,7 +843,7 @@
"type": "object"
},
"payload": {
"description": "A Boolean value to indicate whether payload is wanted. Optional.",
"description": "A Boolean value to indicate whether payload is wanted. A payload is data that is sent in the body of an HTTP POST, PUT, or PATCH message and contains important information about the request. Optional.",
"type": "boolean"
},
"resourceId": {

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

@@ -321,7 +321,7 @@
}
}
},
"revision": "20230124",
"revision": "20240223",
"rootUrl": "https://admob.googleapis.com/",
"schemas": {
"AdUnit": {
@@ -363,7 +363,7 @@
"id": "App",
"properties": {
"appApprovalState": {
"description": "Output only. The approval state for the app.",
"description": "Output only. The approval state for the app. The field is read-only.",
"enum": [
"APP_APPROVAL_STATE_UNSPECIFIED",
"ACTION_REQUIRED",
@@ -644,10 +644,10 @@
"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 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."
"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"
},
@@ -742,10 +742,10 @@
"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 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."
"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"
},
@@ -793,10 +793,10 @@
"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 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."
"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"
},

0
etc/api/admob/v1/crates/5.0.4-api+20240223 Normal file
View File

0
etc/api/admob/v1/crates/5.0.4-cli+20240223 Normal file
View File

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

File diff suppressed because it is too large Load Diff

0
etc/api/adsense/v1.4/crates/5.0.4-api+20201002 Normal file
View File

0
etc/api/adsense/v1.4/crates/5.0.4-cli+20201002 Normal file
View File

44
etc/api/adsense/v2/adsense-api.json
View File

@@ -204,7 +204,7 @@
"type": "integer"
},
"pageToken": {
"description": "A page token, received from a previous `ListAccounts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccounts` must match the call that provided the page token.",
"description": "A page token, received from a previous `ListChildAccounts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListChildAccounts` must match the call that provided the page token.",
"location": "query",
"type": "string"
},
@@ -905,6 +905,7 @@
"CUSTOM_CHANNEL_ID",
"OWNED_SITE_DOMAIN_NAME",
"OWNED_SITE_ID",
"PAGE_URL",
"URL_CHANNEL_NAME",
"URL_CHANNEL_ID",
"BUYER_NETWORK_NAME",
@@ -954,6 +955,7 @@
"Unique ID of a custom channel. The members of this dimension match the values from CustomChannel.reporting_dimension_id.",
"Domain name of a verified site (e.g. \"example.com\"). The members of this dimension match the values from Site.domain.",
"Unique ID of a verified site. The members of this dimension match the values from Site.reporting_dimension_id.",
"URL of the page upon which the ad was served. This is a complete URL including scheme and query parameters. Note that the URL that appears in this dimension may be a canonicalized version of the one that was used in the original request, and so may not exactly match the URL that a user might have seen. Note that there are also some caveats to be aware of when using this dimension. For more information, see [Page URL breakdown](https://support.google.com/adsense/answer/11988478).",
"Name of a URL channel. The members of this dimension match the values from UrlChannel.uri_pattern.",
"Unique ID of a URL channel. The members of this dimension match the values from UrlChannel.reporting_dimension_id.",
"Name of an ad network that returned the winning ads for an ad request (e.g. \"Google AdWords\"). Note that unlike other \"NAME\" dimensions, the members of this dimensions are not localized.",
@@ -1059,7 +1061,11 @@
"COST_PER_CLICK",
"ADS_PER_IMPRESSION",
"TOTAL_EARNINGS",
"WEBSEARCH_RESULT_PAGES"
"WEBSEARCH_RESULT_PAGES",
"FUNNEL_REQUESTS",
"FUNNEL_IMPRESSIONS",
"FUNNEL_CLICKS",
"FUNNEL_RPM"
],
"enumDescriptions": [
"Unspecified metric.",
@@ -1094,7 +1100,11 @@
"Amount the publisher earns each time a user clicks on an ad. CPC is calculated by dividing the estimated revenue by the number of clicks received.",
"Number of ad views per impression.",
"Total earnings are the gross estimated earnings from revenue shared traffic before any parent and child account revenue share is applied.",
"Number of results pages."
"Number of results pages.",
"Number of requests for non-ad units (for example a related search unit). For more information, see [Funnel requests](https://support.google.com/adsense/answer/11586959).",
"Number of requests for non-ad units ads that returned content that was shown to the user. For more information, see [Funnel impressions](https://support.google.com/adsense/answer/11585767).",
"Number of times a user clicked on a non-ad unit, triggering further ad requests. For more information, see [Funnel clicks](https://support.google.com/adsense/answer/11586382).",
"Revenue per thousand funnel impressions. This is calculated by dividing estimated revenue by the number of funnel impressions multiplied by 1000. For more information, see [Funnel RPM](https://support.google.com/adsense/answer/11585979)."
],
"location": "query",
"repeated": true,
@@ -1215,6 +1225,7 @@
"CUSTOM_CHANNEL_ID",
"OWNED_SITE_DOMAIN_NAME",
"OWNED_SITE_ID",
"PAGE_URL",
"URL_CHANNEL_NAME",
"URL_CHANNEL_ID",
"BUYER_NETWORK_NAME",
@@ -1264,6 +1275,7 @@
"Unique ID of a custom channel. The members of this dimension match the values from CustomChannel.reporting_dimension_id.",
"Domain name of a verified site (e.g. \"example.com\"). The members of this dimension match the values from Site.domain.",
"Unique ID of a verified site. The members of this dimension match the values from Site.reporting_dimension_id.",
"URL of the page upon which the ad was served. This is a complete URL including scheme and query parameters. Note that the URL that appears in this dimension may be a canonicalized version of the one that was used in the original request, and so may not exactly match the URL that a user might have seen. Note that there are also some caveats to be aware of when using this dimension. For more information, see [Page URL breakdown](https://support.google.com/adsense/answer/11988478).",
"Name of a URL channel. The members of this dimension match the values from UrlChannel.uri_pattern.",
"Unique ID of a URL channel. The members of this dimension match the values from UrlChannel.reporting_dimension_id.",
"Name of an ad network that returned the winning ads for an ad request (e.g. \"Google AdWords\"). Note that unlike other \"NAME\" dimensions, the members of this dimensions are not localized.",
@@ -1369,7 +1381,11 @@
"COST_PER_CLICK",
"ADS_PER_IMPRESSION",
"TOTAL_EARNINGS",
"WEBSEARCH_RESULT_PAGES"
"WEBSEARCH_RESULT_PAGES",
"FUNNEL_REQUESTS",
"FUNNEL_IMPRESSIONS",
"FUNNEL_CLICKS",
"FUNNEL_RPM"
],
"enumDescriptions": [
"Unspecified metric.",
@@ -1404,7 +1420,11 @@
"Amount the publisher earns each time a user clicks on an ad. CPC is calculated by dividing the estimated revenue by the number of clicks received.",
"Number of ad views per impression.",
"Total earnings are the gross estimated earnings from revenue shared traffic before any parent and child account revenue share is applied.",
"Number of results pages."
"Number of results pages.",
"Number of requests for non-ad units (for example a related search unit). For more information, see [Funnel requests](https://support.google.com/adsense/answer/11586959).",
"Number of requests for non-ad units ads that returned content that was shown to the user. For more information, see [Funnel impressions](https://support.google.com/adsense/answer/11585767).",
"Number of times a user clicked on a non-ad unit, triggering further ad requests. For more information, see [Funnel clicks](https://support.google.com/adsense/answer/11586382).",
"Revenue per thousand funnel impressions. This is calculated by dividing estimated revenue by the number of funnel impressions multiplied by 1000. For more information, see [Funnel RPM](https://support.google.com/adsense/answer/11585979)."
],
"location": "query",
"repeated": true,
@@ -1729,7 +1749,7 @@
"type": "integer"
},
"pageToken": {
"description": "A page token, received from a previous `ListPayments` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListPayments` must match the call that provided the page token.",
"description": "A page token, received from a previous `ListSavedReports` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSavedReports` must match the call that provided the page token.",
"location": "query",
"type": "string"
},
@@ -1824,7 +1844,7 @@
}
}
},
"revision": "20230124",
"revision": "20240305",
"rootUrl": "https://adsense.googleapis.com/",
"schemas": {
"Account": {
@@ -1983,7 +2003,7 @@
"type": "string"
},
"state": {
"description": "State of the ad unit.",
"description": "Required. State of the ad unit.",
"enum": [
"STATE_UNSPECIFIED",
"ACTIVE",
@@ -2079,6 +2099,14 @@
"MATCHED_CONTENT",
"LINK"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
true
],
"enumDescriptions": [
"Unspecified ad unit type.",
"Display ad unit.",

0
etc/api/adsense/v2/crates/5.0.4-api+20240305 Normal file
View File

0
etc/api/adsense/v2/crates/5.0.4-cli+20240305 Normal file
View File

0
etc/api/adsensehost/v4.1/crates/5.0.4-api+20200930 Normal file
View File

0
etc/api/adsensehost/v4.1/crates/5.0.4-cli+20200930 Normal file
View File

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

@@ -423,7 +423,7 @@
}
}
},
"revision": "20230123",
"revision": "20240304",
"rootUrl": "https://alertcenter.googleapis.com/",
"schemas": {
"AbuseDetected": {
@@ -434,29 +434,87 @@
"$ref": "EntityList",
"description": "List of abusive users/entities to be displayed in a table in the alert."
},
"alertDescriptor": {
"description": "Displayed after Customer abuse detected - {alert_descriptor}. If missing, alert name will be displayed as Customer abuse detected.",
"type": "string"
},
"nextSteps": {
"description": "Customizable text to display in the next steps section of the alert. Will be parsed as HTML to allow new paragraphs and hyperlinks.",
"type": "string"
},
"product": {
"description": "Product that the abuse is originating from.",
"type": "string"
},
"subAlertId": {
"description": "Unique identifier of each alert that is onboarded.",
"description": "Unique identifier of each sub alert that is onboarded.",
"type": "string"
},
"summary": {
"description": "Customizable text to display in the summary section of the alert. Will be parsed as HTML to allow new paragraphs and hyperlinks.",
"variationType": {
"description": "Variation of AbuseDetected alerts. The variation_type determines the texts displayed the alert details. This differs from sub_alert_id because each sub alert can have multiple variation_types, representing different stages of the alert.",
"enum": [
"ABUSE_DETECTED_VARIATION_TYPE_UNSPECIFIED",
"DRIVE_ABUSIVE_CONTENT",
"LIMITED_DISABLE"
],
"enumDescriptions": [
"AbuseDetected alert variation type unspecified. No alert should be unspecified.",
"Variation displayed for Drive abusive content alerts.",
"Variation displayed for Limited Disable alerts, when a Google service is disabled for a user, totally or partially, due to the user's abusive behavior."
],
"type": "string"
}
},
"type": "object"
},
"AccessApproval": {
"description": "Alert that is triggered when Google support requests to access customer data.",
"id": "AccessApproval",
"properties": {
"justificationReason": {
"description": "Justification for data access based on justification enums.",
"items": {
"enum": [
"JUSTIFICATION_UNSPECIFIED",
"CUSTOMER_INITIATED_SUPPORT",
"GOOGLE_INITIATED_REVIEW",
"GOOGLE_INITIATED_SERVICE",
"THIRD_PARTY_DATA_REQUEST",
"GOOGLE_RESPONSE_TO_PRODUCTION_ALERT"
],
"enumDescriptions": [
"Justification unspecified",
"Customer Initiated Support",
"Google Initiated Review",
"Google Initiated Service",
"Third Party Data Request",
"Google Response to Production Alert"
],
"type": "string"
},
"type": "array"
},
"officeLocation": {
"description": "Office location of Google staff requesting access such as \"US\".",
"type": "string"
},
"products": {
"description": "Products within scope of the Access Approvals request.",
"items": {
"type": "string"
},
"type": "array"
},
"requestId": {
"description": "ID of the Access Approvals request. This is a helpful field when requesting support from Google.",
"type": "string"
},
"scope": {
"description": "Scope of access, also known as a resource. This is further narrowed down by the product field.",
"type": "string"
},
"tickets": {
"description": "Support tickets related to this Access Approvals request. Populated if there is an associated case number.",
"items": {
"$ref": "SupportTicket"
},
"type": "array"
}
},
"type": "object"
},
"AccountSuspensionDetails": {
"description": "Details about why an account is receiving an account suspension warning.",
"id": "AccountSuspensionDetails",
@@ -764,20 +822,20 @@
"type": "object"
},
"ApnsCertificateExpirationInfo": {
"description": "The explanation message associated with ApnsCertificationExpiring and ApnsCertificationExpired alerts.",
"description": "The explanation message associated with \"APNS certificate is expiring soon\" and \"APNS certificate has expired\" alerts.",
"id": "ApnsCertificateExpirationInfo",
"properties": {
"appleId": {
"description": "The Apple ID used for the certificate may be blank if admins didn't enter it.",
"description": "The Apple ID used to create the certificate. It may be blank if admins didn't enter it.",
"type": "string"
},
"expirationTime": {
"description": "The expiration date of the APNS Certificate.",
"description": "The expiration date of the APNS certificate.",
"format": "google-datetime",
"type": "string"
},
"uid": {
"description": "The UID for the certificate.",
"description": "The UID of the certificate.",
"type": "string"
}
},
@@ -1099,6 +1157,41 @@
},
"type": "object"
},
"DeviceManagementRule": {
"description": "Alerts from Device Management Rules configured by Admin.",
"id": "DeviceManagementRule",
"properties": {
"deviceId": {
"description": "Required. The device ID.",
"type": "string"
},
"deviceModel": {
"description": "The model of the device.",
"type": "string"
},
"deviceType": {
"description": "The type of the device.",
"type": "string"
},
"email": {
"description": "The email of the user this alert was created for.",
"type": "string"
},
"iosVendorId": {
"description": "Required for iOS, empty for others.",
"type": "string"
},
"resourceId": {
"description": "The device resource ID.",
"type": "string"
},
"serialNumber": {
"description": "The serial number of the device.",
"type": "string"
}
},
"type": "object"
},
"DlpRuleViolation": {
"description": "Alerts that get triggered on violations of Data Loss Prevention (DLP) rules.",
"id": "DlpRuleViolation",
@@ -1225,6 +1318,11 @@
"description": "The recipient of this email.",
"type": "string"
},
"sentTime": {
"description": "The sent time of the email.",
"format": "google-datetime",
"type": "string"
},
"subjectText": {
"description": "The email subject text (only available for reported emails).",
"type": "string"
@@ -1809,6 +1907,21 @@
},
"type": "object"
},
"SupportTicket": {
"description": "Support ticket related to Access Approvals request",
"id": "SupportTicket",
"properties": {
"ticketId": {
"description": "Support ticket ID",
"type": "string"
},
"ticketUrl": {
"description": "Link to support ticket",
"type": "string"
}
},
"type": "object"
},
"SuspiciousActivity": {
"description": "A mobile suspicious activity alert. Derived from audit logs.",
"id": "SuspiciousActivity",

0
etc/api/alertcenter/v1beta1/crates/5.0.4-api+20240304 Normal file
View File

0
etc/api/alertcenter/v1beta1/crates/5.0.4-cli+20240304 Normal file
View File

0
etc/api/analytics/v3/crates/5.0.4-api+20190807 Normal file
View File

0
etc/api/analytics/v3/crates/5.0.4-cli+20190807 Normal file
View File

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

File diff suppressed because it is too large Load Diff

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

@@ -15,7 +15,7 @@
"baseUrl": "https://analyticsdata.googleapis.com/",
"batchPath": "batch",
"canonicalName": "AnalyticsData",
"description": "Accesses report data in Google Analytics.",
"description": "Accesses report data in Google Analytics. Warning: Creating multiple Customer Applications, Accounts, or Projects to simulate or act as a single Customer Application, Account, or Project (respectively) or to circumvent Service-specific usage limits or quotas is a direct violation of Google Cloud Platform Terms of Service as well as Google APIs Terms of Service. These actions can result in immediate termination of your GCP project(s) without any warning. ",
"discoveryVersion": "v1",
"documentationLink": "https://developers.google.com/analytics/devguides/reporting/data/v1/",
"fullyEncodeReservedExpansion": true,
@@ -310,10 +310,137 @@
"https://www.googleapis.com/auth/analytics.readonly"
]
}
},
"resources": {
"audienceExports": {
"methods": {
"create": {
"description": "Creates an audience export for later retrieval. This method quickly returns the audience export's resource name and initiates a long running asynchronous request to form an audience export. To export the users in an audience export, first create the audience export through this method and then send the audience resource name to the `QueryAudienceExport` method. See [Creating an Audience Export](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics) for an introduction to Audience Exports with examples. An audience export is a snapshot of the users currently in the audience at the time of audience export creation. Creating audience exports for one audience on different days will return different results as users enter and exit the audience. Audiences in Google Analytics 4 allow you to segment your users in the ways that are important to your business. To learn more, see https://support.google.com/analytics/answer/9267572. Audience exports contain the users in each audience. Audience Export APIs have some methods at alpha and other methods at beta stability. The intention is to advance methods to beta stability after some feedback and adoption. To give your feedback on this API, complete the [Google Analytics Audience Export API Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.",
"flatPath": "v1beta/properties/{propertiesId}/audienceExports",
"httpMethod": "POST",
"id": "analyticsdata.properties.audienceExports.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The parent resource where this audience export will be created. Format: `properties/{property}`",
"location": "path",
"pattern": "^properties/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/audienceExports",
"request": {
"$ref": "AudienceExport"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/analytics",
"https://www.googleapis.com/auth/analytics.readonly"
]
},
"get": {
"description": "Gets configuration metadata about a specific audience export. This method can be used to understand an audience export after it has been created. See [Creating an Audience Export](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics) for an introduction to Audience Exports with examples. Audience Export APIs have some methods at alpha and other methods at beta stability. The intention is to advance methods to beta stability after some feedback and adoption. To give your feedback on this API, complete the [Google Analytics Audience Export API Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.",
"flatPath": "v1beta/properties/{propertiesId}/audienceExports/{audienceExportsId}",
"httpMethod": "GET",
"id": "analyticsdata.properties.audienceExports.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The audience export resource name. Format: `properties/{property}/audienceExports/{audience_export}`",
"location": "path",
"pattern": "^properties/[^/]+/audienceExports/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "AudienceExport"
},
"scopes": [
"https://www.googleapis.com/auth/analytics",
"https://www.googleapis.com/auth/analytics.readonly"
]
},
"list": {
"description": "Lists all audience exports for a property. This method can be used for you to find and reuse existing audience exports rather than creating unnecessary new audience exports. The same audience can have multiple audience exports that represent the export of users that were in an audience on different days. See [Creating an Audience Export](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics) for an introduction to Audience Exports with examples. Audience Export APIs have some methods at alpha and other methods at beta stability. The intention is to advance methods to beta stability after some feedback and adoption. To give your feedback on this API, complete the [Google Analytics Audience Export API Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.",
"flatPath": "v1beta/properties/{propertiesId}/audienceExports",
"httpMethod": "GET",
"id": "analyticsdata.properties.audienceExports.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "Optional. The maximum number of audience exports to return. The service may return fewer than this value. If unspecified, at most 200 audience exports will be returned. The maximum value is 1000 (higher values will be coerced to the maximum).",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. A page token, received from a previous `ListAudienceExports` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAudienceExports` must match the call that provided the page token.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. All audience exports for this property will be listed in the response. Format: `properties/{property}`",
"location": "path",
"pattern": "^properties/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+parent}/audienceExports",
"response": {
"$ref": "ListAudienceExportsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/analytics",
"https://www.googleapis.com/auth/analytics.readonly"
]
},
"query": {
"description": "Retrieves an audience export of users. After creating an audience, the users are not immediately available for exporting. First, a request to `CreateAudienceExport` is necessary to create an audience export of users, and then second, this method is used to retrieve the users in the audience export. See [Creating an Audience Export](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics) for an introduction to Audience Exports with examples. Audiences in Google Analytics 4 allow you to segment your users in the ways that are important to your business. To learn more, see https://support.google.com/analytics/answer/9267572. Audience Export APIs have some methods at alpha and other methods at beta stability. The intention is to advance methods to beta stability after some feedback and adoption. To give your feedback on this API, complete the [Google Analytics Audience Export API Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.",
"flatPath": "v1beta/properties/{propertiesId}/audienceExports/{audienceExportsId}:query",
"httpMethod": "POST",
"id": "analyticsdata.properties.audienceExports.query",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the audience export to retrieve users from. Format: `properties/{property}/audienceExports/{audience_export}`",
"location": "path",
"pattern": "^properties/[^/]+/audienceExports/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+name}:query",
"request": {
"$ref": "QueryAudienceExportRequest"
},
"response": {
"$ref": "QueryAudienceExportResponse"
},
"scopes": [
"https://www.googleapis.com/auth/analytics",
"https://www.googleapis.com/auth/analytics.readonly"
]
}
}
}
}
}
},
"revision": "20230123",
"revision": "20240304",
"rootUrl": "https://analyticsdata.googleapis.com/",
"schemas": {
"ActiveMetricRestriction": {
@@ -344,6 +471,86 @@
},
"type": "object"
},
"AudienceExport": {
"description": "An audience export is a list of users in an audience at the time of the list's creation. One audience may have multiple audience exports created for different days.",
"id": "AudienceExport",
"properties": {
"audience": {
"description": "Required. The audience resource name. This resource name identifies the audience being listed and is shared between the Analytics Data & Admin APIs. Format: `properties/{property}/audiences/{audience}`",
"type": "string"
},
"audienceDisplayName": {
"description": "Output only. The descriptive display name for this audience. For example, \"Purchasers\".",
"readOnly": true,
"type": "string"
},
"beginCreatingTime": {
"description": "Output only. The time when CreateAudienceExport was called and the AudienceExport began the `CREATING` state.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"creationQuotaTokensCharged": {
"description": "Output only. The total quota tokens charged during creation of the AudienceExport. Because this token count is based on activity from the `CREATING` state, this tokens charged will be fixed once an AudienceExport enters the `ACTIVE` or `FAILED` states.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"dimensions": {
"description": "Required. The dimensions requested and displayed in the query response.",
"items": {
"$ref": "V1betaAudienceDimension"
},
"type": "array"
},
"errorMessage": {
"description": "Output only. Error message is populated when an audience export fails during creation. A common reason for such a failure is quota exhaustion.",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Output only. Identifier. The audience export resource name assigned during creation. This resource name identifies this `AudienceExport`. Format: `properties/{property}/audienceExports/{audience_export}`",
"readOnly": true,
"type": "string"
},
"percentageCompleted": {
"description": "Output only. The percentage completed for this audience export ranging between 0 to 100.",
"format": "double",
"readOnly": true,
"type": "number"
},
"rowCount": {
"description": "Output only. The total number of rows in the AudienceExport result.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"state": {
"description": "Output only. The current state for this AudienceExport.",
"enum": [
"STATE_UNSPECIFIED",
"CREATING",
"ACTIVE",
"FAILED"
],
"enumDescriptions": [
"Unspecified state will never be used.",
"The AudienceExport is currently creating and will be available in the future. Creating occurs immediately after the CreateAudienceExport call.",
"The AudienceExport is fully created and ready for querying. An AudienceExport is updated to active asynchronously from a request; this occurs some time (for example 15 minutes) after the initial create call.",
"The AudienceExport failed to be created. It is possible that re-requesting this audience export will succeed."
],
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"AudienceListMetadata": {
"description": "This metadata is currently blank.",
"id": "AudienceListMetadata",
"properties": {},
"type": "object"
},
"BatchRunPivotReportsRequest": {
"description": "The batch request containing multiple pivot report requests.",
"id": "BatchRunPivotReportsRequest",
@@ -602,7 +809,7 @@
"type": "object"
},
"DateRange": {
"description": "A contiguous set of days: startDate, startDate + 1, ..., endDate. Requests are allowed up to 4 date ranges.",
"description": "A contiguous set of days: `startDate`, `startDate + 1`, ..., `endDate`. Requests are allowed up to 4 date ranges.",
"id": "DateRange",
"properties": {
"endDate": {
@@ -629,7 +836,7 @@
"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 supported by core reporting methods such as `runReport` and `batchRunReports`. See [Realtime Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/realtime-api-schema#dimensions) for the list of dimension names supported by the `runRealtimeReport` method. See [Funnel Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/exploration-api-schema#dimensions) for the list of dimension names supported by the `runFunnelReport` method. 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"
}
},
@@ -703,7 +910,7 @@
"type": "string"
},
"customDefinition": {
"description": "True if the dimension is a custom dimension for this property.",
"description": "True if the dimension is custom to this property. This includes user, event, & item scoped custom dimensions; to learn more about custom dimensions, see https://support.google.com/analytics/answer/14240153. This also include custom channel groups; to learn more about custom channel groups, see https://support.google.com/analytics/answer/13051316.",
"type": "boolean"
},
"deprecatedApiNames": {
@@ -844,8 +1051,26 @@
},
"type": "object"
},
"ListAudienceExportsResponse": {
"description": "A list of all audience exports for a property.",
"id": "ListAudienceExportsResponse",
"properties": {
"audienceExports": {
"description": "Each audience export for a property.",
"items": {
"$ref": "AudienceExport"
},
"type": "array"
},
"nextPageToken": {
"description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.",
"type": "string"
}
},
"type": "object"
},
"Metadata": {
"description": "The dimensions and metrics currently accepted in reporting methods.",
"description": "The dimensions, metrics and comparisons currently accepted in reporting methods.",
"id": "Metadata",
"properties": {
"dimensions": {
@@ -882,7 +1107,7 @@
"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 supported by core reporting methods such as `runReport` and `batchRunReports`. See [Realtime Metrics](https://developers.google.com/analytics/devguides/reporting/data/v1/realtime-api-schema#metrics) for the list of metric names supported by the `runRealtimeReport` method. See [Funnel Metrics](https://developers.google.com/analytics/devguides/reporting/data/v1/exploration-api-schema#metrics) for the list of metric names supported by the `runFunnelReport` method. 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"
}
},
@@ -1070,7 +1295,7 @@
"type": "object"
},
"MinuteRange": {
"description": "A contiguous set of minutes: startMinutesAgo, startMinutesAgo + 1, ..., endMinutesAgo. Requests are allowed up to 2 minute ranges.",
"description": "A contiguous set of minutes: `startMinutesAgo`, `startMinutesAgo + 1`, ..., `endMinutesAgo`. Requests are allowed up to 2 minute ranges.",
"id": "MinuteRange",
"properties": {
"endMinutesAgo": {
@@ -1138,6 +1363,41 @@
},
"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, successful response of the operation. 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"
},
"OrderBy": {
"description": "Order bys define how rows will be sorted in the response. For example, ordering rows by descending event count is one ordering, and ordering rows by the event name string is a different ordering.",
"id": "OrderBy",
@@ -1173,7 +1433,7 @@
"type": "array"
},
"limit": {
"description": "The number of unique combinations of dimension values to return in this pivot. The `limit` parameter is required. A `limit` of 10,000 is common for single pivot requests. The product of the `limit` for each `pivot` in a `RunPivotReportRequest` must not exceed 100,000. For example, a two pivot request with `limit: 1000` in each pivot will fail because the product is `1,000,000`.",
"description": "The number of unique combinations of dimension values to return in this pivot. The `limit` parameter is required. A `limit` of 10,000 is common for single pivot requests. The product of the `limit` for each `pivot` in a `RunPivotReportRequest` must not exceed 250,000. For example, a two pivot request with `limit: 1000` in each pivot will fail because the product is `1,000,000`.",
"format": "int64",
"type": "string"
},
@@ -1297,15 +1557,55 @@
},
"tokensPerDay": {
"$ref": "QuotaStatus",
"description": "Standard Analytics Properties can use up to 25,000 tokens per day; Analytics 360 Properties can use 250,000 tokens per day. Most requests consume fewer than 10 tokens."
"description": "Standard Analytics Properties can use up to 200,000 tokens per day; Analytics 360 Properties can use 2,000,000 tokens per day. Most requests consume fewer than 10 tokens."
},
"tokensPerHour": {
"$ref": "QuotaStatus",
"description": "Standard Analytics Properties can use up to 5,000 tokens per hour; Analytics 360 Properties can use 50,000 tokens per hour. An API request consumes a single number of tokens, and that number is deducted from all of the hourly, daily, and per project hourly quotas."
"description": "Standard Analytics Properties can use up to 40,000 tokens per hour; Analytics 360 Properties can use 400,000 tokens per hour. An API request consumes a single number of tokens, and that number is deducted from all of the hourly, daily, and per project hourly quotas."
},
"tokensPerProjectPerHour": {
"$ref": "QuotaStatus",
"description": "Analytics Properties can use up to 25% of their tokens per project per hour. This amounts to standard Analytics Properties can use up to 1,250 tokens per project per hour, and Analytics 360 Properties can use 12,500 tokens per project per hour. An API request consumes a single number of tokens, and that number is deducted from all of the hourly, daily, and per project hourly quotas."
"description": "Analytics Properties can use up to 35% of their tokens per project per hour. This amounts to standard Analytics Properties can use up to 14,000 tokens per project per hour, and Analytics 360 Properties can use 140,000 tokens per project per hour. An API request consumes a single number of tokens, and that number is deducted from all of the hourly, daily, and per project hourly quotas."
}
},
"type": "object"
},
"QueryAudienceExportRequest": {
"description": "A request to list users in an audience export.",
"id": "QueryAudienceExportRequest",
"properties": {
"limit": {
"description": "Optional. The number of rows to return. If unspecified, 10,000 rows are returned. The API returns a maximum of 250,000 rows per request, no matter how many you ask for. `limit` must be positive. The API can also return fewer rows than the requested `limit`, if there aren't as many dimension values as the `limit`. To learn more about this pagination parameter, see [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).",
"format": "int64",
"type": "string"
},
"offset": {
"description": "Optional. The row count of the start row. The first row is counted as row 0. When paging, the first request does not specify offset; or equivalently, sets offset to 0; the first request returns the first `limit` of rows. The second request sets offset to the `limit` of the first request; the second request returns the second `limit` of rows. To learn more about this pagination parameter, see [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"QueryAudienceExportResponse": {
"description": "A list of users in an audience export.",
"id": "QueryAudienceExportResponse",
"properties": {
"audienceExport": {
"$ref": "AudienceExport",
"description": "Configuration data about AudienceExport being queried. Returned to help interpret the audience rows in this response. For example, the dimensions in this AudienceExport correspond to the columns in the AudienceRows."
},
"audienceRows": {
"description": "Rows for each user in an audience export. The number of rows in this response will be less than or equal to request's page size.",
"items": {
"$ref": "V1betaAudienceRow"
},
"type": "array"
},
"rowCount": {
"description": "The total number of rows in the AudienceExport result. `rowCount` is independent of the number of rows returned in the response, the `limit` request parameter, and the `offset` request parameter. For example if a query returns 175 rows and includes `limit` of 50 in the API request, the response will contain `rowCount` of 175 but only 50 rows. To learn more about this pagination parameter, see [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).",
"format": "int32",
"type": "integer"
}
},
"type": "object"
@@ -1336,19 +1636,26 @@
"type": "string"
},
"dataLossFromOtherRow": {
"description": "If true, indicates some buckets of dimension combinations are rolled into \"(other)\" row. This can happen for high cardinality reports.",
"description": "If true, indicates some buckets of dimension combinations are rolled into \"(other)\" row. This can happen for high cardinality reports. The metadata parameter dataLossFromOtherRow is populated based on the aggregated data table used in the report. The parameter will be accurately populated regardless of the filters and limits in the report. For example, the (other) row could be dropped from the report because the request contains a filter on sessionSource = google. This parameter will still be populated if data loss from other row was present in the input aggregate data used to generate this report. To learn more, see [About the (other) row and data sampling](https://support.google.com/analytics/answer/13208658#reports).",
"type": "boolean"
},
"emptyReason": {
"description": "If empty reason is specified, the report is empty for this reason.",
"type": "string"
},
"samplingMetadatas": {
"description": "If this report results is [sampled](https://support.google.com/analytics/answer/13331292), this describes the percentage of events used in this report. One `samplingMetadatas` is populated for each date range. Each `samplingMetadatas` corresponds to a date range in order that date ranges were specified in the request. However if the results are not sampled, this field will not be defined.",
"items": {
"$ref": "SamplingMetadata"
},
"type": "array"
},
"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).",
"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).",
"type": "boolean"
},
"timeZone": {
@@ -1410,7 +1717,7 @@
"type": "array"
},
"keepEmptyRows": {
"description": "If false or unspecified, each row with all metrics equal to 0 will not be returned. If true, these rows will be returned if they are not separately removed by a filter.",
"description": "If false or unspecified, each row with all metrics equal to 0 will not be returned. If true, these rows will be returned if they are not separately removed by a filter. Regardless of this `keep_empty_rows` setting, only data recorded by the Google Analytics (GA4) property can be displayed in a report. For example if a property never logs a `purchase` event, then a query for the `eventName` dimension and `eventCount` metric will not have a row eventName: \"purchase\" and eventCount: 0.",
"type": "boolean"
},
"metricFilter": {
@@ -1512,7 +1819,7 @@
"type": "array"
},
"limit": {
"description": "The number of rows to return. If unspecified, 10,000 rows are returned. The API returns a maximum of 100,000 rows per request, no matter how many you ask for. `limit` must be positive. The API can also return fewer rows than the requested `limit`, if there aren't as many dimension values as the `limit`. For instance, there are fewer than 300 possible values for the dimension `country`, so when reporting on only `country`, you can't get more than 300 rows, even if you set `limit` to a higher value.",
"description": "The number of rows to return. If unspecified, 10,000 rows are returned. The API returns a maximum of 250,000 rows per request, no matter how many you ask for. `limit` must be positive. The API can also return fewer rows than the requested `limit`, if there aren't as many dimension values as the `limit`. For instance, there are fewer than 300 possible values for the dimension `country`, so when reporting on only `country`, you can't get more than 300 rows, even if you set `limit` to a higher value.",
"format": "int64",
"type": "string"
},
@@ -1652,7 +1959,7 @@
},
"dimensionFilter": {
"$ref": "FilterExpression",
"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."
"description": "Dimension filters let you 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.",
@@ -1662,11 +1969,11 @@
"type": "array"
},
"keepEmptyRows": {
"description": "If false or unspecified, each row with all metrics equal to 0 will not be returned. If true, these rows will be returned if they are not separately removed by a filter.",
"description": "If false or unspecified, each row with all metrics equal to 0 will not be returned. If true, these rows will be returned if they are not separately removed by a filter. Regardless of this `keep_empty_rows` setting, only data recorded by the Google Analytics (GA4) property can be displayed in a report. For example if a property never logs a `purchase` event, then a query for the `eventName` dimension and `eventCount` metric will not have a row eventName: \"purchase\" and eventCount: 0.",
"type": "boolean"
},
"limit": {
"description": "The number of rows to return. If unspecified, 10,000 rows are returned. The API returns a maximum of 100,000 rows per request, no matter how many you ask for. `limit` must be positive. The API can also return fewer rows than the requested `limit`, if there aren't as many dimension values as the `limit`. For instance, there are fewer than 300 possible values for the dimension `country`, so when reporting on only `country`, you can't get more than 300 rows, even if you set `limit` to a higher value. To learn more about this pagination parameter, see [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).",
"description": "The number of rows to return. If unspecified, 10,000 rows are returned. The API returns a maximum of 250,000 rows per request, no matter how many you ask for. `limit` must be positive. The API can also return fewer rows than the requested `limit`, if there aren't as many dimension values as the `limit`. For instance, there are fewer than 300 possible values for the dimension `country`, so when reporting on only `country`, you can't get more than 300 rows, even if you set `limit` to a higher value. To learn more about this pagination parameter, see [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).",
"format": "int64",
"type": "string"
},
@@ -1791,6 +2098,23 @@
},
"type": "object"
},
"SamplingMetadata": {
"description": "If this report results is [sampled](https://support.google.com/analytics/answer/13331292), this describes the percentage of events used in this report. Sampling is the practice of analyzing a subset of all data in order to uncover the meaningful information in the larger data set.",
"id": "SamplingMetadata",
"properties": {
"samplesReadCount": {
"description": "The total number of events read in this sampled report for a date range. This is the size of the subset this property's data that was analyzed in this report.",
"format": "int64",
"type": "string"
},
"samplingSpaceSize": {
"description": "The total number of events present in this property's data that could have been analyzed in this report for a date range. Sampling uncovers the meaningful information about the larger data set, and this is the size of the larger data set. To calculate the percentage of available data that was used in this report, compute `samplesReadCount/samplingSpaceSize`.",
"format": "int64",
"type": "string"
}
},
"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",
@@ -1805,6 +2129,33 @@
},
"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"
},
"StringFilter": {
"description": "The filter for string",
"id": "StringFilter",
@@ -1841,6 +2192,42 @@
}
},
"type": "object"
},
"V1betaAudienceDimension": {
"description": "An audience dimension is a user attribute. Specific user attributed are requested and then later returned in the `QueryAudienceExportResponse`.",
"id": "V1betaAudienceDimension",
"properties": {
"dimensionName": {
"description": "Optional. The API name of the dimension. See the [API Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-api-schema#dimensions) for the list of dimension names.",
"type": "string"
}
},
"type": "object"
},
"V1betaAudienceDimensionValue": {
"description": "The value of a dimension.",
"id": "V1betaAudienceDimensionValue",
"properties": {
"value": {
"description": "Value as a string if the dimension type is a string.",
"type": "string"
}
},
"type": "object"
},
"V1betaAudienceRow": {
"description": "Dimension value attributes for the audience user row.",
"id": "V1betaAudienceRow",
"properties": {
"dimensionValues": {
"description": "Each dimension value attribute for an audience user. One dimension value will be added for each dimension column requested.",
"items": {
"$ref": "V1betaAudienceDimensionValue"
},
"type": "array"
}
},
"type": "object"
}
},
"servicePath": "",

0
etc/api/analyticsdata/v1beta/crates/5.0.4-api+20240304 Normal file
View File

0
etc/api/analyticsdata/v1beta/crates/5.0.4-cli+20240304 Normal file
View File

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

@@ -155,7 +155,7 @@
}
}
},
"revision": "20221104",
"revision": "20240123",
"rootUrl": "https://analyticsreporting.googleapis.com/",
"schemas": {
"Activity": {

0
etc/api/analyticsreporting/v4/crates/5.0.4-api+20240123 Normal file
View File

0
etc/api/analyticsreporting/v4/crates/5.0.4-cli+20240123 Normal file
View File

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

@@ -631,6 +631,32 @@
"$ref": "Device"
}
},
"getSimLockState": {
"description": "Gets a device's SIM lock state.",
"flatPath": "v1/partners/{partnersId}/devices:getSimLockState",
"httpMethod": "POST",
"id": "androiddeviceprovisioning.partners.devices.getSimLockState",
"parameterOrder": [
"partnerId"
],
"parameters": {
"partnerId": {
"description": "Required. The ID of the partner.",
"format": "int64",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/partners/{+partnerId}/devices:getSimLockState",
"request": {
"$ref": "GetDeviceSimLockStateRequest"
},
"response": {
"$ref": "GetDeviceSimLockStateResponse"
}
},
"metadata": {
"description": "Updates reseller metadata associated with the device. Android devices only.",
"flatPath": "v1/partners/{partnersId}/devices/{devicesId}/metadata",
@@ -825,13 +851,18 @@
}
}
},
"revision": "20230115",
"revision": "20240304",
"rootUrl": "https://androiddeviceprovisioning.googleapis.com/",
"schemas": {
"ClaimDeviceRequest": {
"description": "Request message to claim a device on behalf of a customer.",
"id": "ClaimDeviceRequest",
"properties": {
"configurationId": {
"description": "Optional. The ID of the configuration applied to the device section.",
"format": "int64",
"type": "string"
},
"customerId": {
"description": "The ID of the customer for whom the device is being claimed.",
"format": "int64",
@@ -868,7 +899,7 @@
"type": "string"
},
"simlockProfileId": {
"description": "Optional. Must and can only be set when DeviceProvisioningSectionType is SECTION_TYPE_SIM_LOCK. The unique identifier of the SimLock profile (go/simlock/profiles).",
"description": "Optional. Must and can only be set when DeviceProvisioningSectionType is SECTION_TYPE_SIM_LOCK. The unique identifier of the SimLock profile.",
"format": "int64",
"type": "string"
}
@@ -1009,6 +1040,11 @@
"description": "Required. The resource name of the selected DPC (device policy controller) in the format `customers/[CUSTOMER_ID]/dpcs/*`. To list the supported DPCs, call `customers.dpcs.list`.",
"type": "string"
},
"forcedResetTime": {
"description": "Optional. The timeout before forcing factory reset the device if the device doesn't go through provisioning in the setup wizard, usually due to lack of network connectivity during setup wizard. Ranges from 0-6 hours, with 2 hours being the default if unset.",
"format": "google-duration",
"type": "string"
},
"isDefault": {
"description": "Required. Whether this is the default configuration that zero-touch enrollment applies to any new devices the organization purchases in the future. Only one customer configuration can be the default. Setting this value to `true`, changes the previous default configuration's `isDefault` value to `false`.",
"type": "boolean"
@@ -1495,6 +1531,39 @@
},
"type": "object"
},
"GetDeviceSimLockStateRequest": {
"description": "Request to get a device's SIM lock status.",
"id": "GetDeviceSimLockStateRequest",
"properties": {
"deviceIdentifier": {
"$ref": "DeviceIdentifier",
"description": "Required. Required. The device identifier to search for."
}
},
"type": "object"
},
"GetDeviceSimLockStateResponse": {
"description": "Response containing a device's SimLock state.",
"id": "GetDeviceSimLockStateResponse",
"properties": {
"simLockState": {
"enum": [
"SIM_LOCK_STATE_UNSPECIFIED",
"UNLOCKED",
"LOCKED_TO_PARTNER",
"LOCKED_TO_OTHER_PARTNER"
],
"enumDescriptions": [
"Invalid code. Shouldn't be used.",
"Device is not SIM locked.",
"Device is SIM locked to the partner querying SIM lock state.",
"Device is SIM locked to a different partner."
],
"type": "string"
}
},
"type": "object"
},
"GoogleWorkspaceAccount": {
"description": "A Google Workspace customer.",
"id": "GoogleWorkspaceAccount",
@@ -1645,6 +1714,11 @@
"description": "Identifies one claim request.",
"id": "PartnerClaim",
"properties": {
"configurationId": {
"description": "Optional. The ID of the configuration applied to the device section.",
"format": "int64",
"type": "string"
},
"customerId": {
"description": "The ID of the customer for whom the device is being claimed.",
"format": "int64",
@@ -1679,6 +1753,11 @@
"Zero-touch enrollment section type."
],
"type": "string"
},
"simlockProfileId": {
"description": "Optional. Must and can only be set when DeviceProvisioningSectionType is SECTION_TYPE_SIM_LOCK. The unique identifier of the SimLock profile.",
"format": "int64",
"type": "string"
}
},
"type": "object"
@@ -1752,7 +1831,8 @@
"SINGLE_DEVICE_STATUS_INVALID_SECTION_TYPE",
"SINGLE_DEVICE_STATUS_SECTION_NOT_YOURS",
"SINGLE_DEVICE_STATUS_INVALID_TOKEN",
"SINGLE_DEVICE_STATUS_REVOKED_TOKEN"
"SINGLE_DEVICE_STATUS_REVOKED_TOKEN",
"SINGLE_DEVICE_STATUS_DEVICE_LIMIT_EXCEEDED"
],
"enumDescriptions": [
"Invalid code. Shouldn't be used.",
@@ -1764,7 +1844,8 @@
"Invalid section type.",
"This section is claimed by another company.",
"Invalid pre-provisioning token.",
"Revoked pre-provisioning token."
"Revoked pre-provisioning token.",
"Status used to indicate a failure due to a device limit being exceeded"
],
"type": "string"
}

0
etc/api/androiddeviceprovisioning/v1/crates/5.0.4-api+20240304 Normal file
View File

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

@@ -987,7 +987,7 @@
"installs": {
"methods": {
"delete": {
"description": "Requests to remove an app from a device. A call to get or list will still show the app as installed on the device until it is actually removed.",
"description": "Requests to remove an app from a device. A call to get or list will still show the app as installed on the device until it is actually removed. A successful response indicates that a removal request has been sent to the device. The call will be considered successful even if the app is not present on the device (e.g. it was never installed, or was removed by the user).",
"flatPath": "androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/installs/{installId}",
"httpMethod": "DELETE",
"id": "androidenterprise.installs.delete",
@@ -2649,7 +2649,7 @@
}
}
},
"revision": "20230123",
"revision": "20240304",
"rootUrl": "https://androidenterprise.googleapis.com/",
"schemas": {
"Administrator": {
@@ -2975,6 +2975,11 @@
"description": "True if this version is a production APK.",
"type": "boolean"
},
"targetSdkVersion": {
"description": "The SDK version this app targets, as specified in the manifest of the APK. See http://developer.android.com/guide/topics/manifest/uses-sdk-element.html",
"format": "int32",
"type": "integer"
},
"track": {
"description": "Deprecated, use trackId instead.",
"enum": [
@@ -3092,7 +3097,7 @@
"type": "array"
},
"autoInstallMode": {
"description": "The auto-install mode. If unset defaults to \"doNotAutoInstall\".",
"description": "The auto-install mode. If unset, defaults to \"doNotAutoInstall\". An app is automatically installed regardless of a set maintenance window.",
"enum": [
"autoInstallModeUnspecified",
"doNotAutoInstall",
@@ -3157,6 +3162,18 @@
"description": "The Google Play Services Android ID for the device encoded as a lowercase hex string. For example, \"123456789abcdef0\".",
"type": "string"
},
"device": {
"description": "The internal hardware codename of the device. This comes from android.os.Build.DEVICE. (field named \"device\" per logs/wireless/android/android_checkin.proto)",
"type": "string"
},
"latestBuildFingerprint": {
"description": "The build fingerprint of the device if known.",
"type": "string"
},
"maker": {
"description": "The manufacturer of the device. This comes from android.os.Build.MANUFACTURER.",
"type": "string"
},
"managementType": {
"description": "Identifies the extent to which the device is controlled by a managed Google Play EMM in various deployment configurations. Possible values include: - \"managedDevice\", a device that has the EMM's device policy controller (DPC) as the device owner. - \"managedProfile\", a device that has a profile managed by the DPC (DPC is profile owner) in addition to a separate, personal profile that is unavailable to the DPC. - \"containerApp\", no longer used (deprecated). - \"unmanagedProfile\", a device that has been allowed (by the domain's admin, using the Admin Console to enable the privilege) to use managed Google Play, but the profile is itself not owned by a DPC. ",
"enum": [
@@ -3173,13 +3190,30 @@
],
"type": "string"
},
"model": {
"description": "The model name of the device. This comes from android.os.Build.MODEL.",
"type": "string"
},
"policy": {
"$ref": "Policy",
"description": "The policy enforced on the device."
},
"product": {
"description": "The product name of the device. This comes from android.os.Build.PRODUCT.",
"type": "string"
},
"report": {
"$ref": "DeviceReport",
"description": "The device report updated with the latest app states."
},
"retailBrand": {
"description": "Retail brand for the device, if set. See android.os.Build.BRAND",
"type": "string"
},
"sdkVersion": {
"description": "API compatibility version.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
@@ -3975,7 +4009,8 @@
"id": "Policy",
"properties": {
"autoUpdatePolicy": {
"description": "Recommended alternative: autoUpdateMode which is set per app, provides greater flexibility around update frequency. 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.",
"deprecated": true,
"description": "Controls when automatic app updates on the device can be applied. Recommended alternative: autoUpdateMode which is set per app, provides greater flexibility around update frequency. When autoUpdateMode is set to AUTO_UPDATE_POSTPONED or AUTO_UPDATE_HIGH_PRIORITY, autoUpdatePolicy 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",
@@ -4145,6 +4180,10 @@
},
"type": "array"
},
"fullDescription": {
"description": "The localized full app store description, if available.",
"type": "string"
},
"iconUrl": {
"description": "A link to an image that can be used as an icon for the product. This image is suitable for use at up to 512px x 512px.",
"type": "string"
@@ -4322,7 +4361,7 @@
"description": "The auto-install policy for the product."
},
"autoUpdateMode": {
"description": "The auto-update mode for the product.",
"description": "The auto-update mode for the product. When autoUpdateMode is used, it always takes precedence over the user's choice. So when a user makes changes to the device settings manually, these changes are ignored.",
"enum": [
"autoUpdateModeUnspecified",
"autoUpdateDefault",
@@ -4338,7 +4377,7 @@
"type": "string"
},
"enterpriseAuthenticationAppLinkConfigs": {
"description": "An authentication URL configuration for the authenticator app of an identity provider. This helps to launch the identity provider's authenticator app during the authentication happening in a private app using Android WebView. Authenticator app should already be the [default handler](https://developer.android.com/training/app-links/verify-site-associations) for the authentication url on the device.",
"description": "An authentication URL configuration for the authenticator app of an identity provider. This helps to launch the identity provider's authenticator app during the authentication happening in a private app using Android WebView. Authenticator app should already be the default handler for the authentication url on the device.",
"items": {
"$ref": "EnterpriseAuthenticationAppLinkConfig"
},

0
etc/api/androidenterprise/v1/crates/5.0.4-api+20240304 Normal file
View File

0
etc/api/androidenterprise/v1/crates/5.0.4-cli+20240304 Normal file
View File

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

File diff suppressed because it is too large Load Diff

0
etc/api/androidmanagement/v1/crates/5.0.4-api+20240221 Normal file
View File

0
etc/api/androidmanagement/v1/crates/5.0.4-cli+20240221 Normal file
View File

0
etc/api/androidpublisher/v2/crates/5.0.4-api+20200331 Normal file
View File

0
etc/api/androidpublisher/v2/crates/5.0.4-cli+20200331 Normal file
View File

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

File diff suppressed because it is too large Load Diff

0
etc/api/androidpublisher/v3/crates/5.0.4-api+20240229 Normal file
View File

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

@@ -1036,7 +1036,7 @@
]
},
"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.",
"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations",
"httpMethod": "GET",
"id": "apigateway.projects.locations.operations.list",
@@ -1083,7 +1083,7 @@
}
}
},
"revision": "20221213",
"revision": "20240221",
"rootUrl": "https://apigateway.googleapis.com/",
"schemas": {
"ApigatewayApi": {
@@ -1336,14 +1336,14 @@
"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 Google Cloud 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. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `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 Google Cloud 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. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `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. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.",
"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`.",
"description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).",
"type": "string"
}
},
@@ -1555,7 +1555,7 @@
"type": "object"
},
"ApigatewayLocation": {
"description": "A resource that represents Google Cloud Platform location.",
"description": "A resource that represents a Google Cloud location.",
"id": "ApigatewayLocation",
"properties": {
"displayName": {
@@ -1617,7 +1617,7 @@
"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`.",
"description": "The normal, successful response of the operation. 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"
}
},
@@ -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`, 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/).",
"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": {

0
etc/api/apigateway/v1/crates/5.0.4-api+20240221 Normal file
View File

0
etc/api/apigateway/v1/crates/5.0.4-cli+20240221 Normal file
View File

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

@@ -1036,7 +1036,7 @@
]
},
"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.",
"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/operations",
"httpMethod": "GET",
"id": "apigateway.projects.locations.operations.list",
@@ -1083,7 +1083,7 @@
}
}
},
"revision": "20221213",
"revision": "20240221",
"rootUrl": "https://apigateway.googleapis.com/",
"schemas": {
"ApigatewayApi": {
@@ -1332,6 +1332,7 @@
"type": "object"
},
"ApigatewayBackendConfig": {
"deprecated": true,
"description": "Configuration for all backends.",
"id": "ApigatewayBackendConfig",
"properties": {
@@ -1351,14 +1352,14 @@
"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 Google Cloud 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. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `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 Google Cloud 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. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `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. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.",
"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`.",
"description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).",
"type": "string"
}
},
@@ -1464,6 +1465,7 @@
"properties": {
"backendConfig": {
"$ref": "ApigatewayBackendConfig",
"deprecated": true,
"description": "Required. Backend settings that are applied to all backends of the Gateway."
}
},
@@ -1581,7 +1583,7 @@
"type": "object"
},
"ApigatewayLocation": {
"description": "A resource that represents Google Cloud Platform location.",
"description": "A resource that represents a Google Cloud location.",
"id": "ApigatewayLocation",
"properties": {
"displayName": {
@@ -1643,7 +1645,7 @@
"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`.",
"description": "The normal, successful response of the operation. 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"
}
},
@@ -1717,7 +1719,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`, 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/).",
"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": {

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

File diff suppressed because it is too large Load Diff

0
etc/api/apigee/v1/crates/5.0.4-api+20240222 Normal file
View File

0
etc/api/apigee/v1/crates/5.0.4-cli+20240222 Normal file
View File

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

@@ -396,7 +396,7 @@
}
}
},
"revision": "20230118",
"revision": "20240303",
"rootUrl": "https://apikeys.googleapis.com/",
"schemas": {
"Operation": {
@@ -428,7 +428,7 @@
"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`.",
"description": "The normal, successful response of the operation. 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"
}
},

0
etc/api/apikeys/v2/crates/5.0.4-api+20240303 Normal file
View File

0
etc/api/apikeys/v2/crates/5.0.4-cli+20240303 Normal file
View File

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

@@ -144,6 +144,21 @@
"location": "path",
"required": true,
"type": "string"
},
"includeExtraData": {
"description": "Options to include extra data",
"enum": [
"INCLUDE_EXTRA_DATA_UNSPECIFIED",
"INCLUDE_EXTRA_DATA_NONE",
"INCLUDE_GOOGLE_GENERATED_METADATA"
],
"enumDescriptions": [
"Unspecified: No extra data will be returned",
"Do not return any extra data",
"Return GGCM associated with the resources"
],
"location": "query",
"type": "string"
}
},
"path": "v1/apps/{appsId}",
@@ -156,6 +171,47 @@
"https://www.googleapis.com/auth/cloud-platform.read-only"
]
},
"listRuntimes": {
"description": "Lists all the available runtimes for the application.",
"flatPath": "v1/apps/{appsId}:listRuntimes",
"httpMethod": "GET",
"id": "appengine.apps.listRuntimes",
"parameterOrder": [
"appsId"
],
"parameters": {
"appsId": {
"description": "Part of `parent`. Required. Name of the parent Application resource. Example: apps/myapp.",
"location": "path",
"required": true,
"type": "string"
},
"environment": {
"description": "Optional. The environment of the Application.",
"enum": [
"ENVIRONMENT_UNSPECIFIED",
"STANDARD",
"FLEXIBLE"
],
"enumDescriptions": [
"Default value.",
"App Engine Standard.",
"App Engine Flexible"
],
"location": "query",
"type": "string"
}
},
"path": "v1/apps/{appsId}:listRuntimes",
"response": {
"$ref": "ListRuntimesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/appengine.admin",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
]
},
"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. iap - Identity-Aware Proxy properties for the application.",
"flatPath": "v1/apps/{appsId}",
@@ -967,7 +1023,7 @@
]
},
"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.",
"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.",
"flatPath": "v1/apps/{appsId}/operations",
"httpMethod": "GET",
"id": "appengine.apps.operations.list",
@@ -1599,46 +1655,61 @@
"locations": {
"resources": {
"applications": {
"methods": {
"get": {
"description": "Gets information about an application.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}",
"httpMethod": "GET",
"id": "appengine.projects.locations.applications.get",
"parameterOrder": [
"projectsId",
"locationsId",
"applicationsId"
],
"parameters": {
"applicationsId": {
"description": "Part of `name`. See documentation of `projectsId`.",
"location": "path",
"required": true,
"type": "string"
},
"locationsId": {
"description": "Part of `name`. See documentation of `projectsId`.",
"location": "path",
"required": true,
"type": "string"
},
"projectsId": {
"description": "Part of `name`. Name of the Application resource to get. Example: apps/myapp.",
"location": "path",
"required": true,
"type": "string"
"resources": {
"authorizedDomains": {
"methods": {
"list": {
"description": "Lists all domains the user is authorized to administer.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/authorizedDomains",
"httpMethod": "GET",
"id": "appengine.projects.locations.applications.authorizedDomains.list",
"parameterOrder": [
"projectsId",
"locationsId",
"applicationsId"
],
"parameters": {
"applicationsId": {
"description": "Part of `parent`. See documentation of `projectsId`.",
"location": "path",
"required": true,
"type": "string"
},
"locationsId": {
"description": "Part of `parent`. See documentation of `projectsId`.",
"location": "path",
"required": true,
"type": "string"
},
"pageSize": {
"description": "Maximum results to return per page.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Continuation token for fetching the next page of results.",
"location": "query",
"type": "string"
},
"projectsId": {
"description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "v1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/authorizedDomains",
"response": {
"$ref": "ListAuthorizedDomainsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/appengine.admin",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
]
}
},
"path": "v1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}",
"response": {
"$ref": "Application"
},
"scopes": [
"https://www.googleapis.com/auth/appengine.admin",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
]
}
}
}
}
@@ -1647,7 +1718,7 @@
}
}
},
"revision": "20230114",
"revision": "20240226",
"rootUrl": "https://appengine.googleapis.com/",
"schemas": {
"ApiConfigHandler": {
@@ -1733,7 +1804,8 @@
"type": "string"
},
"codeBucket": {
"description": "Google Cloud Storage bucket that can be used for storing files associated with this application. This bucket is associated with the application and can be used by the gcloud deployment commands.@OutputOnly",
"description": "Output only. Google Cloud Storage bucket that can be used for storing files associated with this application. This bucket is associated with the application and can be used by the gcloud deployment commands.@OutputOnly",
"readOnly": true,
"type": "string"
},
"databaseType": {
@@ -1753,7 +1825,8 @@
"type": "string"
},
"defaultBucket": {
"description": "Google Cloud Storage bucket that can be used by this application to store content.@OutputOnly",
"description": "Output only. Google Cloud Storage bucket that can be used by this application to store content.@OutputOnly",
"readOnly": true,
"type": "string"
},
"defaultCookieExpiration": {
@@ -1762,7 +1835,8 @@
"type": "string"
},
"defaultHostname": {
"description": "Hostname used to reach this application, as resolved by App Engine.@OutputOnly",
"description": "Output only. Hostname used to reach this application, as resolved by App Engine.@OutputOnly",
"readOnly": true,
"type": "string"
},
"dispatchRules": {
@@ -1777,9 +1851,18 @@
"description": "The feature specific settings to be used in the application."
},
"gcrDomain": {
"description": "The Google Container Registry domain used for storing managed build docker images for this application.",
"description": "Output only. The Google Container Registry domain used for storing managed build docker images for this application.",
"readOnly": true,
"type": "string"
},
"generatedCustomerMetadata": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"description": "Additional Google Generated Customer Metadata, this field won't be provided by default and can be requested by setting the IncludeExtraData field in GetApplicationRequest",
"type": "object"
},
"iap": {
"$ref": "IdentityAwareProxy"
},
@@ -1792,7 +1875,8 @@
"type": "string"
},
"name": {
"description": "Full path to the Application resource in the API. Example: apps/myapp.@OutputOnly",
"description": "Output only. Full path to the Application resource in the API. Example: apps/myapp.@OutputOnly",
"readOnly": true,
"type": "string"
},
"serviceAccount": {
@@ -1870,7 +1954,7 @@
"type": "object"
},
"AuthorizedDomain": {
"description": "A domain that a user has been authorized to administer. To authorize use of a domain, verify ownership via Webmaster Central (https://www.google.com/webmasters/verification/home).",
"description": "A domain that a user has been authorized to administer. To authorize use of a domain, verify ownership via Search Console (https://search.google.com/search-console/welcome).",
"id": "AuthorizedDomain",
"properties": {
"id": {
@@ -2038,6 +2122,36 @@
},
"type": "object"
},
"ContainerState": {
"description": "ContainerState contains the externally-visible container state that is used to communicate the state and reasoning for that state to the CLH. This data is not persisted by CCFE, but is instead derived from CCFE's internal representation of the container state.",
"id": "ContainerState",
"properties": {
"currentReasons": {
"$ref": "Reasons"
},
"previousReasons": {
"$ref": "Reasons",
"description": "The previous and current reasons for a container state will be sent for a container event. CLHs that need to know the signal that caused the container event to trigger (edges) as opposed to just knowing the state can act upon differences in the previous and current reasons.Reasons will be provided for every system: service management, data governance, abuse, and billing.If this is a CCFE-triggered event used for reconciliation then the current reasons will be set to their *_CONTROL_PLANE_SYNC state. The previous reasons will contain the last known set of non-unknown non-control_plane_sync reasons for the state."
},
"state": {
"description": "The current state of the container. This state is the culmination of all of the opinions from external systems that CCFE knows about of the container.",
"enum": [
"UNKNOWN_STATE",
"ON",
"OFF",
"DELETED"
],
"enumDescriptions": [
"A container should never be in an unknown state. Receipt of a container with this state is an error.",
"CCFE considers the container to be serving or transitioning into serving.",
"CCFE considers the container to be in an OFF state. This could occur due to various factors. The state could be triggered by Google-internal audits (ex. abuse suspension, billing closed) or cleanups trigged by compliance systems (ex. data governance hide). User-initiated events such as service management deactivation trigger a container to an OFF state.CLHs might choose to do nothing in this case or to turn off costly resources. CLHs need to consider the customer experience if an ON/OFF/ON sequence of state transitions occurs vs. the cost of deleting resources, keeping metadata about resources, or even keeping resources live for a period of time.CCFE will not send any new customer requests to the CLH when the container is in an OFF state. However, CCFE will allow all previous customer requests relayed to CLH to complete.",
"This state indicates that the container has been (or is being) completely removed. This is often due to a data governance purge request and therefore resources should be deleted when this state is reached."
],
"type": "string"
}
},
"type": "object"
},
"CpuUtilization": {
"description": "Target scaling by CPU usage.",
"id": "CpuUtilization",
@@ -2088,6 +2202,28 @@
},
"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, 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": {
"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"
},
"DebugInstanceRequest": {
"description": "Request message for Instances.DebugInstance.",
"id": "DebugInstanceRequest",
@@ -2329,6 +2465,21 @@
},
"type": "object"
},
"FlexibleRuntimeSettings": {
"description": "Runtime settings for the App Engine flexible environment.",
"id": "FlexibleRuntimeSettings",
"properties": {
"operatingSystem": {
"description": "The operating system of the application runtime.",
"type": "string"
},
"runtimeVersion": {
"description": "The runtime version of an App Engine flexible application.",
"type": "string"
}
},
"type": "object"
},
"GoogleAppengineV1betaLocationMetadata": {
"description": "Metadata for the given google.cloud.location.Location.",
"id": "GoogleAppengineV1betaLocationMetadata",
@@ -2406,7 +2557,8 @@
"type": "string"
},
"oauth2ClientSecretSha256": {
"description": "Hex-encoded SHA-256 hash of the client secret.@OutputOnly",
"description": "Output only. Hex-encoded SHA-256 hash of the client secret.@OutputOnly",
"readOnly": true,
"type": "string"
}
},
@@ -2677,6 +2829,24 @@
},
"type": "object"
},
"ListRuntimesResponse": {
"description": "Response message for Applications.ListRuntimes.",
"id": "ListRuntimesResponse",
"properties": {
"nextPageToken": {
"description": "Continuation token for fetching the next page of results.",
"type": "string"
},
"runtimes": {
"description": "The runtimes available to the requested application.",
"items": {
"$ref": "Runtime"
},
"type": "array"
}
},
"type": "object"
},
"ListServicesResponse": {
"description": "Response message for Services.ListServices.",
"id": "ListServicesResponse",
@@ -2754,7 +2924,7 @@
"type": "object"
},
"Location": {
"description": "A resource that represents Google Cloud Platform location.",
"description": "A resource that represents a Google Cloud location.",
"id": "Location",
"properties": {
"displayName": {
@@ -2976,7 +3146,7 @@
"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.",
"description": "The normal, successful response of the operation. 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"
}
},
@@ -3137,42 +3307,12 @@
"description": "The projects metadata for this project. required"
},
"state": {
"$ref": "ProjectState",
"$ref": "ContainerState",
"description": "The state of the project that led to this event."
}
},
"type": "object"
},
"ProjectState": {
"description": "ProjectState contains the externally-visible project state that is used to communicate the state and reasoning for that state to the CLH. This data is not persisted by CCFE, but is instead derived from CCFE's internal representation of the project state.",
"id": "ProjectState",
"properties": {
"currentReasons": {
"$ref": "Reasons"
},
"previousReasons": {
"$ref": "Reasons",
"description": "The previous and current reasons for a project state will be sent for a project event. CLHs that need to know the signal that caused the project event to trigger (edges) as opposed to just knowing the state can act upon differences in the previous and current reasons.Reasons will be provided for every system: service management, data governance, abuse, and billing.If this is a CCFE-triggered event used for reconciliation then the current reasons will be set to their *_CONTROL_PLANE_SYNC state. The previous reasons will contain the last known set of non-unknown non-control_plane_sync reasons for the state.Reasons fields are deprecated. New tenants should only use the state field. If you must know the reason(s) behind a specific state, please consult with CCFE team first (cloud-ccfe-discuss@google.com)."
},
"state": {
"description": "The current state of the project. This state is the culmination of all of the opinions from external systems that CCFE knows about of the project.",
"enum": [
"UNKNOWN_STATE",
"ON",
"OFF",
"DELETED"
],
"enumDescriptions": [
"A project should never be in an unknown state. Receipt of a project with this state is an error.",
"CCFE considers the project to be serving or transitioning into serving.",
"CCFE considers the project to be in an OFF state. This could occur due to various factors. The state could be triggered by Google-internal audits (ex. abuse suspension, billing closed) or cleanups trigged by compliance systems (ex. data governance hide). User-initiated events such as service management deactivation trigger a project to an OFF state.CLHs might choose to do nothing in this case or to turn off costly resources. CLHs need to consider the customer experience if an ON/OFF/ON sequence of state transitions occurs vs. the cost of deleting resources, keeping metadata about resources, or even keeping resources live for a period of time.CCFE will not send any new customer requests to the CLH when the project is in an OFF state. However, CCFE will allow all previous customer requests relayed to CLH to complete.",
"This state indicates that the project has been (or is being) completely removed. This is often due to a data governance purge request and therefore resources should be deleted when this state is reached."
],
"type": "string"
}
},
"type": "object"
},
"ProjectsMetadata": {
"description": "ProjectsMetadata is the metadata CCFE stores about the all the relevant projects (tenant, consumer, producer).",
"id": "ProjectsMetadata",
@@ -3195,10 +3335,10 @@
"DELETED"
],
"enumDescriptions": [
"A project should never be in an unknown state. Receipt of a project with this state is an error.",
"CCFE considers the project to be serving or transitioning into serving.",
"CCFE considers the project to be in an OFF state. This could occur due to various factors. The state could be triggered by Google-internal audits (ex. abuse suspension, billing closed) or cleanups trigged by compliance systems (ex. data governance hide). User-initiated events such as service management deactivation trigger a project to an OFF state.CLHs might choose to do nothing in this case or to turn off costly resources. CLHs need to consider the customer experience if an ON/OFF/ON sequence of state transitions occurs vs. the cost of deleting resources, keeping metadata about resources, or even keeping resources live for a period of time.CCFE will not send any new customer requests to the CLH when the project is in an OFF state. However, CCFE will allow all previous customer requests relayed to CLH to complete.",
"This state indicates that the project has been (or is being) completely removed. This is often due to a data governance purge request and therefore resources should be deleted when this state is reached."
"A container should never be in an unknown state. Receipt of a container with this state is an error.",
"CCFE considers the container to be serving or transitioning into serving.",
"CCFE considers the container to be in an OFF state. This could occur due to various factors. The state could be triggered by Google-internal audits (ex. abuse suspension, billing closed) or cleanups trigged by compliance systems (ex. data governance hide). User-initiated events such as service management deactivation trigger a container to an OFF state.CLHs might choose to do nothing in this case or to turn off costly resources. CLHs need to consider the customer experience if an ON/OFF/ON sequence of state transitions occurs vs. the cost of deleting resources, keeping metadata about resources, or even keeping resources live for a period of time.CCFE will not send any new customer requests to the CLH when the container is in an OFF state. However, CCFE will allow all previous customer requests relayed to CLH to complete.",
"This state indicates that the container has been (or is being) completely removed. This is often due to a data governance purge request and therefore resources should be deleted when this state is reached."
],
"type": "string"
},
@@ -3268,7 +3408,7 @@
"type": "object"
},
"Reasons": {
"description": "Projects transition between and within states based on reasons sent from various systems. CCFE will provide the CLH with reasons for the current state per system.The current systems that CCFE supports are: Service Management (Inception) Data Governance (Wipeout) Abuse (Ares) Billing (Internal Cloud Billing API)",
"description": "Containers transition between and within states based on reasons sent from various systems. CCFE will provide the CLH with reasons for the current state per system.The current systems that CCFE supports are: Service Management (Inception) Data Governance (Wipeout) Abuse (Ares) Billing (Internal Cloud Billing API) Service Activation (Service Controller)",
"id": "Reasons",
"properties": {
"abuse": {
@@ -3279,10 +3419,10 @@
"REINSTATE"
],
"enumDescriptions": [
"An unknown reason indicates that the abuse system has not sent a signal for this project.",
"Due to various reasons CCFE might proactively restate a project state to a CLH to ensure that the CLH and CCFE are both aware of the project state. This reason can be tied to any of the states.",
"If a project is deemed abusive we receive a suspend signal. Suspend is a reason to put the project into an INTERNAL_OFF state.",
"Projects that were once considered abusive can later be deemed non-abusive. When this happens we must reinstate the project. Reinstate is a reason to put the project into an ON state."
"An unknown reason indicates that the abuse system has not sent a signal for this container.",
"Due to various reasons CCFE might proactively restate a container state to a CLH to ensure that the CLH and CCFE are both aware of the container state. This reason can be tied to any of the states.",
"If a container is deemed abusive we receive a suspend signal. Suspend is a reason to put the container into an INTERNAL_OFF state.",
"Containers that were once considered abusive can later be deemed non-abusive. When this happens we must reinstate the container. Reinstate is a reason to put the container into an ON state."
],
"type": "string"
},
@@ -3295,11 +3435,11 @@
"OPEN"
],
"enumDescriptions": [
"An unknown reason indicates that the billing system has not sent a signal for this project.",
"Due to various reasons CCFE might proactively restate a project state to a CLH to ensure that the CLH and CCFE are both aware of the project state. This reason can be tied to any of the states.",
"Minor infractions cause a probation signal to be sent. Probation is a reason to put the project into a ON state even though it is a negative signal. CCFE will block mutations for this project while it is on billing probation, but the CLH is expected to serve non-mutation requests.",
"When a billing account is closed, it is a stronger signal about non-payment. Close is a reason to put the project into an INTERNAL_OFF state.",
"Consumers can re-open billing accounts and update accounts to pull them out of probation. When this happens, we get a signal that the account is open. Open is a reason to put the project into an ON state."
"An unknown reason indicates that the billing system has not sent a signal for this container.",
"Due to various reasons CCFE might proactively restate a container state to a CLH to ensure that the CLH and CCFE are both aware of the container state. This reason can be tied to any of the states.",
"Minor infractions cause a probation signal to be sent. Probation is a reason to put the container into a ON state even though it is a negative signal. CCFE will block mutations for this container while it is on billing probation, but the CLH is expected to serve non-mutation requests.",
"When a billing account is closed, it is a stronger signal about non-payment. Close is a reason to put the container into an INTERNAL_OFF state.",
"Consumers can re-open billing accounts and update accounts to pull them out of probation. When this happens, we get a signal that the account is open. Open is a reason to put the container into an ON state."
],
"type": "string"
},
@@ -3312,11 +3452,29 @@
"PURGE"
],
"enumDescriptions": [
"An unknown reason indicates that data governance has not sent a signal for this project.",
"Due to various reasons CCFE might proactively restate a project state to a CLH to ensure that the CLH and CCFE are both aware of the project state. This reason can be tied to any of the states.",
"When a project is deleted we retain some data for a period of time to allow the consumer to change their mind. Data governance sends a signal to hide the data when this occurs. Hide is a reason to put the project in an INTERNAL_OFF state.",
"The decision to un-delete a project can be made. When this happens data governance tells us to unhide any hidden data. Unhide is a reason to put the project in an ON state.",
"After a period of time data must be completely removed from our systems. When data governance sends a purge signal we need to remove data. Purge is a reason to put the project in a DELETED state. Purge is the only event that triggers a delete mutation. All other events have update semantics."
"An unknown reason indicates that data governance has not sent a signal for this container.",
"Due to various reasons CCFE might proactively restate a container state to a CLH to ensure that the CLH and CCFE are both aware of the container state. This reason can be tied to any of the states.",
"When a container is deleted we retain some data for a period of time to allow the consumer to change their mind. Data governance sends a signal to hide the data when this occurs. Hide is a reason to put the container in an INTERNAL_OFF state.",
"The decision to un-delete a container can be made. When this happens data governance tells us to unhide any hidden data. Unhide is a reason to put the container in an ON state.",
"After a period of time data must be completely removed from our systems. When data governance sends a purge signal we need to remove data. Purge is a reason to put the container in a DELETED state. Purge is the only event that triggers a delete mutation. All other events have update semantics."
],
"type": "string"
},
"serviceActivation": {
"description": "Consumer Container denotes if the service is active within a project or not. This information could be used to clean up resources in case service in DISABLED_FULL i.e. Service is inactive > 30 days.",
"enum": [
"SERVICE_ACTIVATION_STATUS_UNSPECIFIED",
"SERVICE_ACTIVATION_ENABLED",
"SERVICE_ACTIVATION_DISABLED",
"SERVICE_ACTIVATION_DISABLED_FULL",
"SERVICE_ACTIVATION_UNKNOWN_REASON"
],
"enumDescriptions": [
"Default Unspecified status",
"Service is active in the project.",
"Service is disabled in the project recently i.e., within last 24 hours.",
"Service has been disabled for configured grace_period (default 30 days).",
"Happens when PSM cannot determine the status of service in a project Could happen due to variety of reasons like PERMISSION_DENIED or Project got deleted etc."
],
"type": "string"
},
@@ -3329,13 +3487,21 @@
"ABORT_DEACTIVATION",
"COMMIT_DEACTIVATION"
],
"enumDeprecated": [
false,
false,
true,
true,
true,
true
],
"enumDescriptions": [
"An unknown reason indicates that we have not received a signal from service management about this project. Since projects are created by request of service management, this reason should never be set.",
"Due to various reasons CCFE might proactively restate a project state to a CLH to ensure that the CLH and CCFE are both aware of the project state. This reason can be tied to any of the states.",
"When a customer activates an API CCFE notifies the CLH and sets the project to the ON state.",
"When a customer deactivates and API service management starts a two-step process to perform the deactivation. The first step is to prepare. Prepare is a reason to put the project in a EXTERNAL_OFF state.",
"If the deactivation is cancelled, service managed needs to abort the deactivation. Abort is a reason to put the project in an ON state.",
"If the deactivation is followed through with, service management needs to finish deactivation. Commit is a reason to put the project in a DELETED state."
"An unknown reason indicates that we have not received a signal from service management about this container. Since containers are created by request of service management, this reason should never be set.",
"Due to various reasons CCFE might proactively restate a container state to a CLH to ensure that the CLH and CCFE are both aware of the container state. This reason can be tied to any of the states.",
"When a customer activates an API CCFE notifies the CLH and sets the container to the ON state.",
"When a customer deactivates and API service management starts a two-step process to perform the deactivation. The first step is to prepare. Prepare is a reason to put the container in a EXTERNAL_OFF state.",
"If the deactivation is cancelled, service managed needs to abort the deactivation. Abort is a reason to put the container in an ON state.",
"If the deactivation is followed through with, service management needs to finish deactivation. Commit is a reason to put the container in a DELETED state."
],
"type": "string"
}
@@ -3429,6 +3595,85 @@
},
"type": "object"
},
"Runtime": {
"description": "Runtime versions for App Engine.",
"id": "Runtime",
"properties": {
"decommissionedDate": {
"$ref": "Date",
"description": "Date when Runtime is decommissioned."
},
"deprecationDate": {
"$ref": "Date",
"description": "Date when Runtime is deprecated."
},
"displayName": {
"description": "User-friendly display name, e.g. 'Node.js 12', etc.",
"type": "string"
},
"endOfSupportDate": {
"$ref": "Date",
"description": "Date when Runtime is end of support."
},
"environment": {
"description": "The environment of the runtime.",
"enum": [
"ENVIRONMENT_UNSPECIFIED",
"STANDARD",
"FLEXIBLE"
],
"enumDescriptions": [
"Default value.",
"App Engine Standard.",
"App Engine Flexible"
],
"type": "string"
},
"name": {
"description": "The name of the runtime, e.g., 'go113', 'nodejs12', etc.",
"type": "string"
},
"stage": {
"description": "The stage of life this runtime is in, e.g., BETA, GA, etc.",
"enum": [
"RUNTIME_STAGE_UNSPECIFIED",
"DEVELOPMENT",
"ALPHA",
"BETA",
"GA",
"DEPRECATED",
"DECOMMISSIONED",
"END_OF_SUPPORT"
],
"enumDescriptions": [
"Not specified.",
"The runtime is in development.",
"The runtime is in the Alpha stage.",
"The runtime is in the Beta stage.",
"The runtime is generally available.",
"The runtime is deprecated.",
"The runtime is no longer supported.",
"The runtime is end of support."
],
"type": "string"
},
"supportedOperatingSystems": {
"description": "Supported operating systems for the runtime, e.g., 'ubuntu22', etc.",
"items": {
"type": "string"
},
"type": "array"
},
"warnings": {
"description": "Warning messages, e.g., a deprecation warning.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ScriptHandler": {
"description": "Executes a script to handle the request that matches the URL pattern.",
"id": "ScriptHandler",
@@ -3444,6 +3689,14 @@
"description": "A Service resource is a logical component of an application that can share state and communicate in a secure fashion with other services. For example, an application that handles customer requests might include separate services to handle tasks such as backend data analysis or API requests from mobile devices. Each service has a collection of versions that define a specific set of code used to implement the functionality of that service.",
"id": "Service",
"properties": {
"generatedCustomerMetadata": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"description": "Additional Google Generated Customer Metadata, this field won't be provided by default and can be requested by setting the IncludeExtraData field in GetServiceRequest",
"type": "object"
},
"id": {
"description": "Relative name of the service within the application. Example: default.@OutputOnly",
"type": "string"
@@ -3737,6 +3990,7 @@
"properties": {
"apiConfig": {
"$ref": "ApiConfigHandler",
"deprecated": true,
"description": "Serving configuration for Google Cloud Endpoints (https://cloud.google.com/endpoints).Only returned in GET requests if view=FULL is set."
},
"appEngineApis": {
@@ -3814,6 +4068,18 @@
},
"type": "array"
},
"flexibleRuntimeSettings": {
"$ref": "FlexibleRuntimeSettings",
"description": "Settings for App Engine flexible runtimes."
},
"generatedCustomerMetadata": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"description": "Additional Google Generated Customer Metadata, this field won't be provided by default and can be requested by setting the IncludeExtraData field in GetVersionRequest",
"type": "object"
},
"handlers": {
"description": "An ordered list of URL-matching patterns that should be applied to incoming requests. The first matching URL handles the request and other request handlers are not attempted.Only returned in GET requests if view=FULL is set.",
"items": {
@@ -3823,7 +4089,7 @@
},
"healthCheck": {
"$ref": "HealthCheck",
"description": "Configures health checking for instances. Unhealthy instances are stopped and replaced with new instances. Only applicable in the App Engine flexible environment.Only returned in GET requests if view=FULL is set."
"description": "Configures health checking for instances. Unhealthy instances are stopped and replaced with new instances. Only applicable in the App Engine flexible environment."
},
"id": {
"description": "Relative name of the version within the service. Example: v1. Version names can contain only lowercase letters, numbers, or hyphens. Reserved names: \"default\", \"latest\", and any name with the prefix \"ah-\".",
@@ -3871,7 +4137,7 @@
},
"livenessCheck": {
"$ref": "LivenessCheck",
"description": "Configures liveness health checking for instances. Unhealthy instances are stopped and replaced with new instancesOnly returned in GET requests if view=FULL is set."
"description": "Configures liveness health checking for instances. Unhealthy instances are stopped and replaced with new instances"
},
"manualScaling": {
"$ref": "ManualScaling",
@@ -3891,7 +4157,7 @@
},
"readinessCheck": {
"$ref": "ReadinessCheck",
"description": "Configures readiness health checking for instances. Unhealthy instances are not put into the backend traffic rotation.Only returned in GET requests if view=FULL is set."
"description": "Configures readiness health checking for instances. Unhealthy instances are not put into the backend traffic rotation."
},
"resources": {
"$ref": "Resources",
@@ -3996,7 +4262,7 @@
"type": "string"
},
"name": {
"description": "Full Serverless VPC Access Connector name e.g. /projects/my-project/locations/us-central1/connectors/c1.",
"description": "Full Serverless VPC Access Connector name e.g. projects/my-project/locations/us-central1/connectors/c1.",
"type": "string"
}
},

0
etc/api/appengine/v1/crates/5.0.4-api+20240226 Normal file
View File

0
etc/api/appengine/v1/crates/5.0.4-cli+20240226 Normal file
View File

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

@@ -663,7 +663,7 @@
]
},
"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.",
"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.",
"flatPath": "v1alpha/apps/{appsId}/operations",
"httpMethod": "GET",
"id": "appengine.apps.operations.list",
@@ -789,6 +789,65 @@
}
},
"resources": {
"applications": {
"resources": {
"authorizedDomains": {
"methods": {
"list": {
"description": "Lists all domains the user is authorized to administer.",
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/authorizedDomains",
"httpMethod": "GET",
"id": "appengine.projects.locations.applications.authorizedDomains.list",
"parameterOrder": [
"projectsId",
"locationsId",
"applicationsId"
],
"parameters": {
"applicationsId": {
"description": "Part of `parent`. See documentation of `projectsId`.",
"location": "path",
"required": true,
"type": "string"
},
"locationsId": {
"description": "Part of `parent`. See documentation of `projectsId`.",
"location": "path",
"required": true,
"type": "string"
},
"pageSize": {
"description": "Maximum results to return per page.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Continuation token for fetching the next page of results.",
"location": "query",
"type": "string"
},
"projectsId": {
"description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "v1alpha/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/authorizedDomains",
"response": {
"$ref": "ListAuthorizedDomainsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/appengine.admin",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
]
}
}
}
}
},
"operations": {
"methods": {
"get": {
@@ -832,7 +891,7 @@
]
},
"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.",
"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.",
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/operations",
"httpMethod": "GET",
"id": "appengine.projects.locations.operations.list",
@@ -887,7 +946,7 @@
}
}
},
"revision": "20230114",
"revision": "20240226",
"rootUrl": "https://appengine.googleapis.com/",
"schemas": {
"AuthorizedCertificate": {
@@ -942,7 +1001,7 @@
"type": "object"
},
"AuthorizedDomain": {
"description": "A domain that a user has been authorized to administer. To authorize use of a domain, verify ownership via Webmaster Central (https://www.google.com/webmasters/verification/home).",
"description": "A domain that a user has been authorized to administer. To authorize use of a domain, verify ownership via Search Console (https://search.google.com/search-console/welcome).",
"id": "AuthorizedDomain",
"properties": {
"id": {
@@ -971,6 +1030,36 @@
},
"type": "object"
},
"ContainerState": {
"description": "ContainerState contains the externally-visible container state that is used to communicate the state and reasoning for that state to the CLH. This data is not persisted by CCFE, but is instead derived from CCFE's internal representation of the container state.",
"id": "ContainerState",
"properties": {
"currentReasons": {
"$ref": "Reasons"
},
"previousReasons": {
"$ref": "Reasons",
"description": "The previous and current reasons for a container state will be sent for a container event. CLHs that need to know the signal that caused the container event to trigger (edges) as opposed to just knowing the state can act upon differences in the previous and current reasons.Reasons will be provided for every system: service management, data governance, abuse, and billing.If this is a CCFE-triggered event used for reconciliation then the current reasons will be set to their *_CONTROL_PLANE_SYNC state. The previous reasons will contain the last known set of non-unknown non-control_plane_sync reasons for the state."
},
"state": {
"description": "The current state of the container. This state is the culmination of all of the opinions from external systems that CCFE knows about of the container.",
"enum": [
"UNKNOWN_STATE",
"ON",
"OFF",
"DELETED"
],
"enumDescriptions": [
"A container should never be in an unknown state. Receipt of a container with this state is an error.",
"CCFE considers the container to be serving or transitioning into serving.",
"CCFE considers the container to be in an OFF state. This could occur due to various factors. The state could be triggered by Google-internal audits (ex. abuse suspension, billing closed) or cleanups trigged by compliance systems (ex. data governance hide). User-initiated events such as service management deactivation trigger a container to an OFF state.CLHs might choose to do nothing in this case or to turn off costly resources. CLHs need to consider the customer experience if an ON/OFF/ON sequence of state transitions occurs vs. the cost of deleting resources, keeping metadata about resources, or even keeping resources live for a period of time.CCFE will not send any new customer requests to the CLH when the container is in an OFF state. However, CCFE will allow all previous customer requests relayed to CLH to complete.",
"This state indicates that the container has been (or is being) completely removed. This is often due to a data governance purge request and therefore resources should be deleted when this state is reached."
],
"type": "string"
}
},
"type": "object"
},
"CreateVersionMetadataV1": {
"description": "Metadata for the given google.longrunning.Operation during a google.appengine.v1.CreateVersionRequest.",
"id": "CreateVersionMetadataV1",
@@ -1147,7 +1236,7 @@
"type": "object"
},
"Location": {
"description": "A resource that represents Google Cloud Platform location.",
"description": "A resource that represents a Google Cloud location.",
"id": "Location",
"properties": {
"displayName": {
@@ -1265,7 +1354,7 @@
"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.",
"description": "The normal, successful response of the operation. 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"
}
},
@@ -1426,42 +1515,12 @@
"description": "The projects metadata for this project. required"
},
"state": {
"$ref": "ProjectState",
"$ref": "ContainerState",
"description": "The state of the project that led to this event."
}
},
"type": "object"
},
"ProjectState": {
"description": "ProjectState contains the externally-visible project state that is used to communicate the state and reasoning for that state to the CLH. This data is not persisted by CCFE, but is instead derived from CCFE's internal representation of the project state.",
"id": "ProjectState",
"properties": {
"currentReasons": {
"$ref": "Reasons"
},
"previousReasons": {
"$ref": "Reasons",
"description": "The previous and current reasons for a project state will be sent for a project event. CLHs that need to know the signal that caused the project event to trigger (edges) as opposed to just knowing the state can act upon differences in the previous and current reasons.Reasons will be provided for every system: service management, data governance, abuse, and billing.If this is a CCFE-triggered event used for reconciliation then the current reasons will be set to their *_CONTROL_PLANE_SYNC state. The previous reasons will contain the last known set of non-unknown non-control_plane_sync reasons for the state.Reasons fields are deprecated. New tenants should only use the state field. If you must know the reason(s) behind a specific state, please consult with CCFE team first (cloud-ccfe-discuss@google.com)."
},
"state": {
"description": "The current state of the project. This state is the culmination of all of the opinions from external systems that CCFE knows about of the project.",
"enum": [
"UNKNOWN_STATE",
"ON",
"OFF",
"DELETED"
],
"enumDescriptions": [
"A project should never be in an unknown state. Receipt of a project with this state is an error.",
"CCFE considers the project to be serving or transitioning into serving.",
"CCFE considers the project to be in an OFF state. This could occur due to various factors. The state could be triggered by Google-internal audits (ex. abuse suspension, billing closed) or cleanups trigged by compliance systems (ex. data governance hide). User-initiated events such as service management deactivation trigger a project to an OFF state.CLHs might choose to do nothing in this case or to turn off costly resources. CLHs need to consider the customer experience if an ON/OFF/ON sequence of state transitions occurs vs. the cost of deleting resources, keeping metadata about resources, or even keeping resources live for a period of time.CCFE will not send any new customer requests to the CLH when the project is in an OFF state. However, CCFE will allow all previous customer requests relayed to CLH to complete.",
"This state indicates that the project has been (or is being) completely removed. This is often due to a data governance purge request and therefore resources should be deleted when this state is reached."
],
"type": "string"
}
},
"type": "object"
},
"ProjectsMetadata": {
"description": "ProjectsMetadata is the metadata CCFE stores about the all the relevant projects (tenant, consumer, producer).",
"id": "ProjectsMetadata",
@@ -1484,10 +1543,10 @@
"DELETED"
],
"enumDescriptions": [
"A project should never be in an unknown state. Receipt of a project with this state is an error.",
"CCFE considers the project to be serving or transitioning into serving.",
"CCFE considers the project to be in an OFF state. This could occur due to various factors. The state could be triggered by Google-internal audits (ex. abuse suspension, billing closed) or cleanups trigged by compliance systems (ex. data governance hide). User-initiated events such as service management deactivation trigger a project to an OFF state.CLHs might choose to do nothing in this case or to turn off costly resources. CLHs need to consider the customer experience if an ON/OFF/ON sequence of state transitions occurs vs. the cost of deleting resources, keeping metadata about resources, or even keeping resources live for a period of time.CCFE will not send any new customer requests to the CLH when the project is in an OFF state. However, CCFE will allow all previous customer requests relayed to CLH to complete.",
"This state indicates that the project has been (or is being) completely removed. This is often due to a data governance purge request and therefore resources should be deleted when this state is reached."
"A container should never be in an unknown state. Receipt of a container with this state is an error.",
"CCFE considers the container to be serving or transitioning into serving.",
"CCFE considers the container to be in an OFF state. This could occur due to various factors. The state could be triggered by Google-internal audits (ex. abuse suspension, billing closed) or cleanups trigged by compliance systems (ex. data governance hide). User-initiated events such as service management deactivation trigger a container to an OFF state.CLHs might choose to do nothing in this case or to turn off costly resources. CLHs need to consider the customer experience if an ON/OFF/ON sequence of state transitions occurs vs. the cost of deleting resources, keeping metadata about resources, or even keeping resources live for a period of time.CCFE will not send any new customer requests to the CLH when the container is in an OFF state. However, CCFE will allow all previous customer requests relayed to CLH to complete.",
"This state indicates that the container has been (or is being) completely removed. This is often due to a data governance purge request and therefore resources should be deleted when this state is reached."
],
"type": "string"
},
@@ -1517,7 +1576,7 @@
"type": "object"
},
"Reasons": {
"description": "Projects transition between and within states based on reasons sent from various systems. CCFE will provide the CLH with reasons for the current state per system.The current systems that CCFE supports are: Service Management (Inception) Data Governance (Wipeout) Abuse (Ares) Billing (Internal Cloud Billing API)",
"description": "Containers transition between and within states based on reasons sent from various systems. CCFE will provide the CLH with reasons for the current state per system.The current systems that CCFE supports are: Service Management (Inception) Data Governance (Wipeout) Abuse (Ares) Billing (Internal Cloud Billing API) Service Activation (Service Controller)",
"id": "Reasons",
"properties": {
"abuse": {
@@ -1528,10 +1587,10 @@
"REINSTATE"
],
"enumDescriptions": [
"An unknown reason indicates that the abuse system has not sent a signal for this project.",
"Due to various reasons CCFE might proactively restate a project state to a CLH to ensure that the CLH and CCFE are both aware of the project state. This reason can be tied to any of the states.",
"If a project is deemed abusive we receive a suspend signal. Suspend is a reason to put the project into an INTERNAL_OFF state.",
"Projects that were once considered abusive can later be deemed non-abusive. When this happens we must reinstate the project. Reinstate is a reason to put the project into an ON state."
"An unknown reason indicates that the abuse system has not sent a signal for this container.",
"Due to various reasons CCFE might proactively restate a container state to a CLH to ensure that the CLH and CCFE are both aware of the container state. This reason can be tied to any of the states.",
"If a container is deemed abusive we receive a suspend signal. Suspend is a reason to put the container into an INTERNAL_OFF state.",
"Containers that were once considered abusive can later be deemed non-abusive. When this happens we must reinstate the container. Reinstate is a reason to put the container into an ON state."
],
"type": "string"
},
@@ -1544,11 +1603,11 @@
"OPEN"
],
"enumDescriptions": [
"An unknown reason indicates that the billing system has not sent a signal for this project.",
"Due to various reasons CCFE might proactively restate a project state to a CLH to ensure that the CLH and CCFE are both aware of the project state. This reason can be tied to any of the states.",
"Minor infractions cause a probation signal to be sent. Probation is a reason to put the project into a ON state even though it is a negative signal. CCFE will block mutations for this project while it is on billing probation, but the CLH is expected to serve non-mutation requests.",
"When a billing account is closed, it is a stronger signal about non-payment. Close is a reason to put the project into an INTERNAL_OFF state.",
"Consumers can re-open billing accounts and update accounts to pull them out of probation. When this happens, we get a signal that the account is open. Open is a reason to put the project into an ON state."
"An unknown reason indicates that the billing system has not sent a signal for this container.",
"Due to various reasons CCFE might proactively restate a container state to a CLH to ensure that the CLH and CCFE are both aware of the container state. This reason can be tied to any of the states.",
"Minor infractions cause a probation signal to be sent. Probation is a reason to put the container into a ON state even though it is a negative signal. CCFE will block mutations for this container while it is on billing probation, but the CLH is expected to serve non-mutation requests.",
"When a billing account is closed, it is a stronger signal about non-payment. Close is a reason to put the container into an INTERNAL_OFF state.",
"Consumers can re-open billing accounts and update accounts to pull them out of probation. When this happens, we get a signal that the account is open. Open is a reason to put the container into an ON state."
],
"type": "string"
},
@@ -1561,11 +1620,29 @@
"PURGE"
],
"enumDescriptions": [
"An unknown reason indicates that data governance has not sent a signal for this project.",
"Due to various reasons CCFE might proactively restate a project state to a CLH to ensure that the CLH and CCFE are both aware of the project state. This reason can be tied to any of the states.",
"When a project is deleted we retain some data for a period of time to allow the consumer to change their mind. Data governance sends a signal to hide the data when this occurs. Hide is a reason to put the project in an INTERNAL_OFF state.",
"The decision to un-delete a project can be made. When this happens data governance tells us to unhide any hidden data. Unhide is a reason to put the project in an ON state.",
"After a period of time data must be completely removed from our systems. When data governance sends a purge signal we need to remove data. Purge is a reason to put the project in a DELETED state. Purge is the only event that triggers a delete mutation. All other events have update semantics."
"An unknown reason indicates that data governance has not sent a signal for this container.",
"Due to various reasons CCFE might proactively restate a container state to a CLH to ensure that the CLH and CCFE are both aware of the container state. This reason can be tied to any of the states.",
"When a container is deleted we retain some data for a period of time to allow the consumer to change their mind. Data governance sends a signal to hide the data when this occurs. Hide is a reason to put the container in an INTERNAL_OFF state.",
"The decision to un-delete a container can be made. When this happens data governance tells us to unhide any hidden data. Unhide is a reason to put the container in an ON state.",
"After a period of time data must be completely removed from our systems. When data governance sends a purge signal we need to remove data. Purge is a reason to put the container in a DELETED state. Purge is the only event that triggers a delete mutation. All other events have update semantics."
],
"type": "string"
},
"serviceActivation": {
"description": "Consumer Container denotes if the service is active within a project or not. This information could be used to clean up resources in case service in DISABLED_FULL i.e. Service is inactive > 30 days.",
"enum": [
"SERVICE_ACTIVATION_STATUS_UNSPECIFIED",
"SERVICE_ACTIVATION_ENABLED",
"SERVICE_ACTIVATION_DISABLED",
"SERVICE_ACTIVATION_DISABLED_FULL",
"SERVICE_ACTIVATION_UNKNOWN_REASON"
],
"enumDescriptions": [
"Default Unspecified status",
"Service is active in the project.",
"Service is disabled in the project recently i.e., within last 24 hours.",
"Service has been disabled for configured grace_period (default 30 days).",
"Happens when PSM cannot determine the status of service in a project Could happen due to variety of reasons like PERMISSION_DENIED or Project got deleted etc."
],
"type": "string"
},
@@ -1578,13 +1655,21 @@
"ABORT_DEACTIVATION",
"COMMIT_DEACTIVATION"
],
"enumDeprecated": [
false,
false,
true,
true,
true,
true
],
"enumDescriptions": [
"An unknown reason indicates that we have not received a signal from service management about this project. Since projects are created by request of service management, this reason should never be set.",
"Due to various reasons CCFE might proactively restate a project state to a CLH to ensure that the CLH and CCFE are both aware of the project state. This reason can be tied to any of the states.",
"When a customer activates an API CCFE notifies the CLH and sets the project to the ON state.",
"When a customer deactivates and API service management starts a two-step process to perform the deactivation. The first step is to prepare. Prepare is a reason to put the project in a EXTERNAL_OFF state.",
"If the deactivation is cancelled, service managed needs to abort the deactivation. Abort is a reason to put the project in an ON state.",
"If the deactivation is followed through with, service management needs to finish deactivation. Commit is a reason to put the project in a DELETED state."
"An unknown reason indicates that we have not received a signal from service management about this container. Since containers are created by request of service management, this reason should never be set.",
"Due to various reasons CCFE might proactively restate a container state to a CLH to ensure that the CLH and CCFE are both aware of the container state. This reason can be tied to any of the states.",
"When a customer activates an API CCFE notifies the CLH and sets the container to the ON state.",
"When a customer deactivates and API service management starts a two-step process to perform the deactivation. The first step is to prepare. Prepare is a reason to put the container in a EXTERNAL_OFF state.",
"If the deactivation is cancelled, service managed needs to abort the deactivation. Abort is a reason to put the container in an ON state.",
"If the deactivation is followed through with, service management needs to finish deactivation. Commit is a reason to put the container in a DELETED state."
],
"type": "string"
}

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

@@ -118,13 +118,7 @@
"httpMethod": "POST",
"id": "appengine.apps.create",
"parameterOrder": [],
"parameters": {
"parent": {
"description": "The project and location in which the application should be created, specified in the format projects/*/locations/*",
"location": "query",
"type": "string"
}
},
"parameters": {},
"path": "v1beta/apps",
"request": {
"$ref": "Application"
@@ -150,6 +144,21 @@
"location": "path",
"required": true,
"type": "string"
},
"includeExtraData": {
"description": "Optional. Options to include extra data",
"enum": [
"INCLUDE_EXTRA_DATA_UNSPECIFIED",
"INCLUDE_EXTRA_DATA_NONE",
"INCLUDE_GOOGLE_GENERATED_METADATA"
],
"enumDescriptions": [
"Unspecified: No extra data will be returned",
"Do not return any extra data",
"Return GGCM associated with the resources"
],
"location": "query",
"type": "string"
}
},
"path": "v1beta/apps/{appsId}",
@@ -162,6 +171,47 @@
"https://www.googleapis.com/auth/cloud-platform.read-only"
]
},
"listRuntimes": {
"description": "Lists all the available runtimes for the application.",
"flatPath": "v1beta/apps/{appsId}:listRuntimes",
"httpMethod": "GET",
"id": "appengine.apps.listRuntimes",
"parameterOrder": [
"appsId"
],
"parameters": {
"appsId": {
"description": "Part of `parent`. Required. Name of the parent Application resource. Example: apps/myapp.",
"location": "path",
"required": true,
"type": "string"
},
"environment": {
"description": "Optional. The environment of the Application.",
"enum": [
"ENVIRONMENT_UNSPECIFIED",
"STANDARD",
"FLEXIBLE"
],
"enumDescriptions": [
"Default value.",
"App Engine Standard.",
"App Engine Flexible"
],
"location": "query",
"type": "string"
}
},
"path": "v1beta/apps/{appsId}:listRuntimes",
"response": {
"$ref": "ListRuntimesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/appengine.admin",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
]
},
"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. iap - Identity-Aware Proxy properties for the application.",
"flatPath": "v1beta/apps/{appsId}",
@@ -973,7 +1023,7 @@
]
},
"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.",
"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.",
"flatPath": "v1beta/apps/{appsId}/operations",
"httpMethod": "GET",
"id": "appengine.apps.operations.list",
@@ -1065,6 +1115,21 @@
"required": true,
"type": "string"
},
"includeExtraData": {
"description": "Optional. Options to include extra data",
"enum": [
"INCLUDE_EXTRA_DATA_UNSPECIFIED",
"INCLUDE_EXTRA_DATA_NONE",
"INCLUDE_GOOGLE_GENERATED_METADATA"
],
"enumDescriptions": [
"Unspecified: No extra data will be returned",
"Do not return any extra data",
"Return GGCM associated with the resources"
],
"location": "query",
"type": "string"
},
"servicesId": {
"description": "Part of `name`. See documentation of `appsId`.",
"location": "path",
@@ -1257,6 +1322,21 @@
"required": true,
"type": "string"
},
"includeExtraData": {
"description": "Optional. Options to include extra data",
"enum": [
"INCLUDE_EXTRA_DATA_UNSPECIFIED",
"INCLUDE_EXTRA_DATA_NONE",
"INCLUDE_GOOGLE_GENERATED_METADATA"
],
"enumDescriptions": [
"Unspecified: No extra data will be returned",
"Do not return any extra data",
"Return GGCM associated with the resources"
],
"location": "query",
"type": "string"
},
"servicesId": {
"description": "Part of `name`. See documentation of `appsId`.",
"location": "path",
@@ -1682,121 +1762,61 @@
},
"resources": {
"applications": {
"methods": {
"create": {
"description": "Creates an App Engine application for a Google Cloud Platform project. Required fields: id - The ID of the target Cloud Platform project. location - The region (https://cloud.google.com/appengine/docs/locations) where you want the App Engine application located.For more information about App Engine applications, see Managing Projects, Applications, and Billing (https://cloud.google.com/appengine/docs/standard/python/console/).",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/applications",
"httpMethod": "POST",
"id": "appengine.projects.locations.applications.create",
"parameterOrder": [
"projectsId",
"locationsId"
],
"parameters": {
"locationsId": {
"description": "Part of `parent`. See documentation of `projectsId`.",
"location": "path",
"required": true,
"type": "string"
},
"projectsId": {
"description": "Part of `parent`. The project and location in which the application should be created, specified in the format projects/*/locations/*",
"location": "path",
"required": true,
"type": "string"
"resources": {
"authorizedDomains": {
"methods": {
"list": {
"description": "Lists all domains the user is authorized to administer.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/authorizedDomains",
"httpMethod": "GET",
"id": "appengine.projects.locations.applications.authorizedDomains.list",
"parameterOrder": [
"projectsId",
"locationsId",
"applicationsId"
],
"parameters": {
"applicationsId": {
"description": "Part of `parent`. See documentation of `projectsId`.",
"location": "path",
"required": true,
"type": "string"
},
"locationsId": {
"description": "Part of `parent`. See documentation of `projectsId`.",
"location": "path",
"required": true,
"type": "string"
},
"pageSize": {
"description": "Maximum results to return per page.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Continuation token for fetching the next page of results.",
"location": "query",
"type": "string"
},
"projectsId": {
"description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "v1beta/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/authorizedDomains",
"response": {
"$ref": "ListAuthorizedDomainsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/appengine.admin",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
]
}
},
"path": "v1beta/projects/{projectsId}/locations/{locationsId}/applications",
"request": {
"$ref": "Application"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets information about an application.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}",
"httpMethod": "GET",
"id": "appengine.projects.locations.applications.get",
"parameterOrder": [
"projectsId",
"locationsId",
"applicationsId"
],
"parameters": {
"applicationsId": {
"description": "Part of `name`. See documentation of `projectsId`.",
"location": "path",
"required": true,
"type": "string"
},
"locationsId": {
"description": "Part of `name`. See documentation of `projectsId`.",
"location": "path",
"required": true,
"type": "string"
},
"projectsId": {
"description": "Part of `name`. Name of the Application resource to get. Example: apps/myapp.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "v1beta/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}",
"response": {
"$ref": "Application"
},
"scopes": [
"https://www.googleapis.com/auth/appengine.admin",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
]
},
"repair": {
"description": "Recreates the required App Engine features for the specified App Engine application, for example a Cloud Storage bucket or App Engine service account. Use this method if you receive an error message about a missing feature, for example, Error retrieving the App Engine service account. If you have deleted your App Engine service account, this will not be able to recreate it. Instead, you should attempt to use the IAM undelete API if possible at https://cloud.google.com/iam/reference/rest/v1/projects.serviceAccounts/undelete?apix_params=%7B\"name\"%3A\"projects%2F-%2FserviceAccounts%2Funique_id\"%2C\"resource\"%3A%7B%7D%7D . If the deletion was recent, the numeric ID can be found in the Cloud Console Activity Log.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}:repair",
"httpMethod": "POST",
"id": "appengine.projects.locations.applications.repair",
"parameterOrder": [
"projectsId",
"locationsId",
"applicationsId"
],
"parameters": {
"applicationsId": {
"description": "Part of `name`. See documentation of `projectsId`.",
"location": "path",
"required": true,
"type": "string"
},
"locationsId": {
"description": "Part of `name`. See documentation of `projectsId`.",
"location": "path",
"required": true,
"type": "string"
},
"projectsId": {
"description": "Part of `name`. Name of the application to repair. Example: apps/myapp",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "v1beta/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}:repair",
"request": {
"$ref": "RepairApplicationRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
},
@@ -1843,7 +1863,7 @@
]
},
"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.",
"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/operations",
"httpMethod": "GET",
"id": "appengine.projects.locations.operations.list",
@@ -1898,7 +1918,7 @@
}
}
},
"revision": "20230114",
"revision": "20240226",
"rootUrl": "https://appengine.googleapis.com/",
"schemas": {
"ApiConfigHandler": {
@@ -2035,6 +2055,14 @@
"readOnly": true,
"type": "string"
},
"generatedCustomerMetadata": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"description": "Additional Google Generated Customer Metadata, this field won't be provided by default and can be requested by setting the IncludeExtraData field in GetApplicationRequest",
"type": "object"
},
"iap": {
"$ref": "IdentityAwareProxy"
},
@@ -2126,7 +2154,7 @@
"type": "object"
},
"AuthorizedDomain": {
"description": "A domain that a user has been authorized to administer. To authorize use of a domain, verify ownership via Webmaster Central (https://www.google.com/webmasters/verification/home).",
"description": "A domain that a user has been authorized to administer. To authorize use of a domain, verify ownership via Search Console (https://search.google.com/search-console/welcome).",
"id": "AuthorizedDomain",
"properties": {
"id": {
@@ -2312,6 +2340,36 @@
},
"type": "object"
},
"ContainerState": {
"description": "ContainerState contains the externally-visible container state that is used to communicate the state and reasoning for that state to the CLH. This data is not persisted by CCFE, but is instead derived from CCFE's internal representation of the container state.",
"id": "ContainerState",
"properties": {
"currentReasons": {
"$ref": "Reasons"
},
"previousReasons": {
"$ref": "Reasons",
"description": "The previous and current reasons for a container state will be sent for a container event. CLHs that need to know the signal that caused the container event to trigger (edges) as opposed to just knowing the state can act upon differences in the previous and current reasons.Reasons will be provided for every system: service management, data governance, abuse, and billing.If this is a CCFE-triggered event used for reconciliation then the current reasons will be set to their *_CONTROL_PLANE_SYNC state. The previous reasons will contain the last known set of non-unknown non-control_plane_sync reasons for the state."
},
"state": {
"description": "The current state of the container. This state is the culmination of all of the opinions from external systems that CCFE knows about of the container.",
"enum": [
"UNKNOWN_STATE",
"ON",
"OFF",
"DELETED"
],
"enumDescriptions": [
"A container should never be in an unknown state. Receipt of a container with this state is an error.",
"CCFE considers the container to be serving or transitioning into serving.",
"CCFE considers the container to be in an OFF state. This could occur due to various factors. The state could be triggered by Google-internal audits (ex. abuse suspension, billing closed) or cleanups trigged by compliance systems (ex. data governance hide). User-initiated events such as service management deactivation trigger a container to an OFF state.CLHs might choose to do nothing in this case or to turn off costly resources. CLHs need to consider the customer experience if an ON/OFF/ON sequence of state transitions occurs vs. the cost of deleting resources, keeping metadata about resources, or even keeping resources live for a period of time.CCFE will not send any new customer requests to the CLH when the container is in an OFF state. However, CCFE will allow all previous customer requests relayed to CLH to complete.",
"This state indicates that the container has been (or is being) completely removed. This is often due to a data governance purge request and therefore resources should be deleted when this state is reached."
],
"type": "string"
}
},
"type": "object"
},
"CpuUtilization": {
"description": "Target scaling by CPU usage.",
"id": "CpuUtilization",
@@ -2391,6 +2449,28 @@
},
"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, 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": {
"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"
},
"DebugInstanceRequest": {
"description": "Request message for Instances.DebugInstance.",
"id": "DebugInstanceRequest",
@@ -3000,6 +3080,24 @@
},
"type": "object"
},
"ListRuntimesResponse": {
"description": "Response message for Applications.ListRuntimes.",
"id": "ListRuntimesResponse",
"properties": {
"nextPageToken": {
"description": "Continuation token for fetching the next page of results.",
"type": "string"
},
"runtimes": {
"description": "The runtimes available to the requested application.",
"items": {
"$ref": "Runtime"
},
"type": "array"
}
},
"type": "object"
},
"ListServicesResponse": {
"description": "Response message for Services.ListServices.",
"id": "ListServicesResponse",
@@ -3077,7 +3175,7 @@
"type": "object"
},
"Location": {
"description": "A resource that represents Google Cloud Platform location.",
"description": "A resource that represents a Google Cloud location.",
"id": "Location",
"properties": {
"displayName": {
@@ -3299,7 +3397,7 @@
"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.",
"description": "The normal, successful response of the operation. 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"
}
},
@@ -3460,42 +3558,12 @@
"description": "The projects metadata for this project. required"
},
"state": {
"$ref": "ProjectState",
"$ref": "ContainerState",
"description": "The state of the project that led to this event."
}
},
"type": "object"
},
"ProjectState": {
"description": "ProjectState contains the externally-visible project state that is used to communicate the state and reasoning for that state to the CLH. This data is not persisted by CCFE, but is instead derived from CCFE's internal representation of the project state.",
"id": "ProjectState",
"properties": {
"currentReasons": {
"$ref": "Reasons"
},
"previousReasons": {
"$ref": "Reasons",
"description": "The previous and current reasons for a project state will be sent for a project event. CLHs that need to know the signal that caused the project event to trigger (edges) as opposed to just knowing the state can act upon differences in the previous and current reasons.Reasons will be provided for every system: service management, data governance, abuse, and billing.If this is a CCFE-triggered event used for reconciliation then the current reasons will be set to their *_CONTROL_PLANE_SYNC state. The previous reasons will contain the last known set of non-unknown non-control_plane_sync reasons for the state.Reasons fields are deprecated. New tenants should only use the state field. If you must know the reason(s) behind a specific state, please consult with CCFE team first (cloud-ccfe-discuss@google.com)."
},
"state": {
"description": "The current state of the project. This state is the culmination of all of the opinions from external systems that CCFE knows about of the project.",
"enum": [
"UNKNOWN_STATE",
"ON",
"OFF",
"DELETED"
],
"enumDescriptions": [
"A project should never be in an unknown state. Receipt of a project with this state is an error.",
"CCFE considers the project to be serving or transitioning into serving.",
"CCFE considers the project to be in an OFF state. This could occur due to various factors. The state could be triggered by Google-internal audits (ex. abuse suspension, billing closed) or cleanups trigged by compliance systems (ex. data governance hide). User-initiated events such as service management deactivation trigger a project to an OFF state.CLHs might choose to do nothing in this case or to turn off costly resources. CLHs need to consider the customer experience if an ON/OFF/ON sequence of state transitions occurs vs. the cost of deleting resources, keeping metadata about resources, or even keeping resources live for a period of time.CCFE will not send any new customer requests to the CLH when the project is in an OFF state. However, CCFE will allow all previous customer requests relayed to CLH to complete.",
"This state indicates that the project has been (or is being) completely removed. This is often due to a data governance purge request and therefore resources should be deleted when this state is reached."
],
"type": "string"
}
},
"type": "object"
},
"ProjectsMetadata": {
"description": "ProjectsMetadata is the metadata CCFE stores about the all the relevant projects (tenant, consumer, producer).",
"id": "ProjectsMetadata",
@@ -3518,10 +3586,10 @@
"DELETED"
],
"enumDescriptions": [
"A project should never be in an unknown state. Receipt of a project with this state is an error.",
"CCFE considers the project to be serving or transitioning into serving.",
"CCFE considers the project to be in an OFF state. This could occur due to various factors. The state could be triggered by Google-internal audits (ex. abuse suspension, billing closed) or cleanups trigged by compliance systems (ex. data governance hide). User-initiated events such as service management deactivation trigger a project to an OFF state.CLHs might choose to do nothing in this case or to turn off costly resources. CLHs need to consider the customer experience if an ON/OFF/ON sequence of state transitions occurs vs. the cost of deleting resources, keeping metadata about resources, or even keeping resources live for a period of time.CCFE will not send any new customer requests to the CLH when the project is in an OFF state. However, CCFE will allow all previous customer requests relayed to CLH to complete.",
"This state indicates that the project has been (or is being) completely removed. This is often due to a data governance purge request and therefore resources should be deleted when this state is reached."
"A container should never be in an unknown state. Receipt of a container with this state is an error.",
"CCFE considers the container to be serving or transitioning into serving.",
"CCFE considers the container to be in an OFF state. This could occur due to various factors. The state could be triggered by Google-internal audits (ex. abuse suspension, billing closed) or cleanups trigged by compliance systems (ex. data governance hide). User-initiated events such as service management deactivation trigger a container to an OFF state.CLHs might choose to do nothing in this case or to turn off costly resources. CLHs need to consider the customer experience if an ON/OFF/ON sequence of state transitions occurs vs. the cost of deleting resources, keeping metadata about resources, or even keeping resources live for a period of time.CCFE will not send any new customer requests to the CLH when the container is in an OFF state. However, CCFE will allow all previous customer requests relayed to CLH to complete.",
"This state indicates that the container has been (or is being) completely removed. This is often due to a data governance purge request and therefore resources should be deleted when this state is reached."
],
"type": "string"
},
@@ -3591,7 +3659,7 @@
"type": "object"
},
"Reasons": {
"description": "Projects transition between and within states based on reasons sent from various systems. CCFE will provide the CLH with reasons for the current state per system.The current systems that CCFE supports are: Service Management (Inception) Data Governance (Wipeout) Abuse (Ares) Billing (Internal Cloud Billing API)",
"description": "Containers transition between and within states based on reasons sent from various systems. CCFE will provide the CLH with reasons for the current state per system.The current systems that CCFE supports are: Service Management (Inception) Data Governance (Wipeout) Abuse (Ares) Billing (Internal Cloud Billing API) Service Activation (Service Controller)",
"id": "Reasons",
"properties": {
"abuse": {
@@ -3602,10 +3670,10 @@
"REINSTATE"
],
"enumDescriptions": [
"An unknown reason indicates that the abuse system has not sent a signal for this project.",
"Due to various reasons CCFE might proactively restate a project state to a CLH to ensure that the CLH and CCFE are both aware of the project state. This reason can be tied to any of the states.",
"If a project is deemed abusive we receive a suspend signal. Suspend is a reason to put the project into an INTERNAL_OFF state.",
"Projects that were once considered abusive can later be deemed non-abusive. When this happens we must reinstate the project. Reinstate is a reason to put the project into an ON state."
"An unknown reason indicates that the abuse system has not sent a signal for this container.",
"Due to various reasons CCFE might proactively restate a container state to a CLH to ensure that the CLH and CCFE are both aware of the container state. This reason can be tied to any of the states.",
"If a container is deemed abusive we receive a suspend signal. Suspend is a reason to put the container into an INTERNAL_OFF state.",
"Containers that were once considered abusive can later be deemed non-abusive. When this happens we must reinstate the container. Reinstate is a reason to put the container into an ON state."
],
"type": "string"
},
@@ -3618,11 +3686,11 @@
"OPEN"
],
"enumDescriptions": [
"An unknown reason indicates that the billing system has not sent a signal for this project.",
"Due to various reasons CCFE might proactively restate a project state to a CLH to ensure that the CLH and CCFE are both aware of the project state. This reason can be tied to any of the states.",
"Minor infractions cause a probation signal to be sent. Probation is a reason to put the project into a ON state even though it is a negative signal. CCFE will block mutations for this project while it is on billing probation, but the CLH is expected to serve non-mutation requests.",
"When a billing account is closed, it is a stronger signal about non-payment. Close is a reason to put the project into an INTERNAL_OFF state.",
"Consumers can re-open billing accounts and update accounts to pull them out of probation. When this happens, we get a signal that the account is open. Open is a reason to put the project into an ON state."
"An unknown reason indicates that the billing system has not sent a signal for this container.",
"Due to various reasons CCFE might proactively restate a container state to a CLH to ensure that the CLH and CCFE are both aware of the container state. This reason can be tied to any of the states.",
"Minor infractions cause a probation signal to be sent. Probation is a reason to put the container into a ON state even though it is a negative signal. CCFE will block mutations for this container while it is on billing probation, but the CLH is expected to serve non-mutation requests.",
"When a billing account is closed, it is a stronger signal about non-payment. Close is a reason to put the container into an INTERNAL_OFF state.",
"Consumers can re-open billing accounts and update accounts to pull them out of probation. When this happens, we get a signal that the account is open. Open is a reason to put the container into an ON state."
],
"type": "string"
},
@@ -3635,11 +3703,29 @@
"PURGE"
],
"enumDescriptions": [
"An unknown reason indicates that data governance has not sent a signal for this project.",
"Due to various reasons CCFE might proactively restate a project state to a CLH to ensure that the CLH and CCFE are both aware of the project state. This reason can be tied to any of the states.",
"When a project is deleted we retain some data for a period of time to allow the consumer to change their mind. Data governance sends a signal to hide the data when this occurs. Hide is a reason to put the project in an INTERNAL_OFF state.",
"The decision to un-delete a project can be made. When this happens data governance tells us to unhide any hidden data. Unhide is a reason to put the project in an ON state.",
"After a period of time data must be completely removed from our systems. When data governance sends a purge signal we need to remove data. Purge is a reason to put the project in a DELETED state. Purge is the only event that triggers a delete mutation. All other events have update semantics."
"An unknown reason indicates that data governance has not sent a signal for this container.",
"Due to various reasons CCFE might proactively restate a container state to a CLH to ensure that the CLH and CCFE are both aware of the container state. This reason can be tied to any of the states.",
"When a container is deleted we retain some data for a period of time to allow the consumer to change their mind. Data governance sends a signal to hide the data when this occurs. Hide is a reason to put the container in an INTERNAL_OFF state.",
"The decision to un-delete a container can be made. When this happens data governance tells us to unhide any hidden data. Unhide is a reason to put the container in an ON state.",
"After a period of time data must be completely removed from our systems. When data governance sends a purge signal we need to remove data. Purge is a reason to put the container in a DELETED state. Purge is the only event that triggers a delete mutation. All other events have update semantics."
],
"type": "string"
},
"serviceActivation": {
"description": "Consumer Container denotes if the service is active within a project or not. This information could be used to clean up resources in case service in DISABLED_FULL i.e. Service is inactive > 30 days.",
"enum": [
"SERVICE_ACTIVATION_STATUS_UNSPECIFIED",
"SERVICE_ACTIVATION_ENABLED",
"SERVICE_ACTIVATION_DISABLED",
"SERVICE_ACTIVATION_DISABLED_FULL",
"SERVICE_ACTIVATION_UNKNOWN_REASON"
],
"enumDescriptions": [
"Default Unspecified status",
"Service is active in the project.",
"Service is disabled in the project recently i.e., within last 24 hours.",
"Service has been disabled for configured grace_period (default 30 days).",
"Happens when PSM cannot determine the status of service in a project Could happen due to variety of reasons like PERMISSION_DENIED or Project got deleted etc."
],
"type": "string"
},
@@ -3652,13 +3738,21 @@
"ABORT_DEACTIVATION",
"COMMIT_DEACTIVATION"
],
"enumDeprecated": [
false,
false,
true,
true,
true,
true
],
"enumDescriptions": [
"An unknown reason indicates that we have not received a signal from service management about this project. Since projects are created by request of service management, this reason should never be set.",
"Due to various reasons CCFE might proactively restate a project state to a CLH to ensure that the CLH and CCFE are both aware of the project state. This reason can be tied to any of the states.",
"When a customer activates an API CCFE notifies the CLH and sets the project to the ON state.",
"When a customer deactivates and API service management starts a two-step process to perform the deactivation. The first step is to prepare. Prepare is a reason to put the project in a EXTERNAL_OFF state.",
"If the deactivation is cancelled, service managed needs to abort the deactivation. Abort is a reason to put the project in an ON state.",
"If the deactivation is followed through with, service management needs to finish deactivation. Commit is a reason to put the project in a DELETED state."
"An unknown reason indicates that we have not received a signal from service management about this container. Since containers are created by request of service management, this reason should never be set.",
"Due to various reasons CCFE might proactively restate a container state to a CLH to ensure that the CLH and CCFE are both aware of the container state. This reason can be tied to any of the states.",
"When a customer activates an API CCFE notifies the CLH and sets the container to the ON state.",
"When a customer deactivates and API service management starts a two-step process to perform the deactivation. The first step is to prepare. Prepare is a reason to put the container in a EXTERNAL_OFF state.",
"If the deactivation is cancelled, service managed needs to abort the deactivation. Abort is a reason to put the container in an ON state.",
"If the deactivation is followed through with, service management needs to finish deactivation. Commit is a reason to put the container in a DELETED state."
],
"type": "string"
}
@@ -3750,6 +3844,85 @@
},
"type": "object"
},
"Runtime": {
"description": "Runtime versions for App Engine.",
"id": "Runtime",
"properties": {
"decommissionedDate": {
"$ref": "Date",
"description": "Date when Runtime is decommissioned."
},
"deprecationDate": {
"$ref": "Date",
"description": "Date when Runtime is deprecated."
},
"displayName": {
"description": "User-friendly display name, e.g. 'Node.js 12', etc.",
"type": "string"
},
"endOfSupportDate": {
"$ref": "Date",
"description": "Date when Runtime is end of support."
},
"environment": {
"description": "The environment of the runtime.",
"enum": [
"ENVIRONMENT_UNSPECIFIED",
"STANDARD",
"FLEXIBLE"
],
"enumDescriptions": [
"Default value.",
"App Engine Standard.",
"App Engine Flexible"
],
"type": "string"
},
"name": {
"description": "The name of the runtime, e.g., 'go113', 'nodejs12', etc.",
"type": "string"
},
"stage": {
"description": "The stage of life this runtime is in, e.g., BETA, GA, etc.",
"enum": [
"RUNTIME_STAGE_UNSPECIFIED",
"DEVELOPMENT",
"ALPHA",
"BETA",
"GA",
"DEPRECATED",
"DECOMMISSIONED",
"END_OF_SUPPORT"
],
"enumDescriptions": [
"Not specified.",
"The runtime is in development.",
"The runtime is in the Alpha stage.",
"The runtime is in the Beta stage.",
"The runtime is generally available.",
"The runtime is deprecated.",
"The runtime is no longer supported.",
"The runtime is end of support."
],
"type": "string"
},
"supportedOperatingSystems": {
"description": "Supported operating systems for the runtime, e.g., 'ubuntu22', etc.",
"items": {
"type": "string"
},
"type": "array"
},
"warnings": {
"description": "Warning messages, e.g., a deprecation warning.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ScriptHandler": {
"description": "Executes a script to handle the request that matches the URL pattern.",
"id": "ScriptHandler",
@@ -3765,6 +3938,14 @@
"description": "A Service resource is a logical component of an application that can share state and communicate in a secure fashion with other services. For example, an application that handles customer requests might include separate services to handle tasks such as backend data analysis or API requests from mobile devices. Each service has a collection of versions that define a specific set of code used to implement the functionality of that service.",
"id": "Service",
"properties": {
"generatedCustomerMetadata": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"description": "Additional Google Generated Customer Metadata, this field won't be provided by default and can be requested by setting the IncludeExtraData field in GetServiceRequest",
"type": "object"
},
"id": {
"description": "Relative name of the service within the application. Example: default.@OutputOnly",
"type": "string"
@@ -4056,6 +4237,7 @@
"properties": {
"apiConfig": {
"$ref": "ApiConfigHandler",
"deprecated": true,
"description": "Serving configuration for Google Cloud Endpoints (https://cloud.google.com/endpoints).Only returned in GET requests if view=FULL is set."
},
"appEngineApis": {
@@ -4137,6 +4319,14 @@
"$ref": "FlexibleRuntimeSettings",
"description": "Settings for App Engine flexible runtimes."
},
"generatedCustomerMetadata": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"description": "Additional Google Generated Customer Metadata, this field won't be provided by default and can be requested by setting the IncludeExtraData field in GetVersionRequest",
"type": "object"
},
"handlers": {
"description": "An ordered list of URL-matching patterns that should be applied to incoming requests. The first matching URL handles the request and other request handlers are not attempted.Only returned in GET requests if view=FULL is set.",
"items": {
@@ -4146,7 +4336,7 @@
},
"healthCheck": {
"$ref": "HealthCheck",
"description": "Configures health checking for instances. Unhealthy instances are stopped and replaced with new instances. Only applicable in the App Engine flexible environment.Only returned in GET requests if view=FULL is set."
"description": "Configures health checking for instances. Unhealthy instances are stopped and replaced with new instances. Only applicable in the App Engine flexible environment."
},
"id": {
"description": "Relative name of the version within the service. Example: v1. Version names can contain only lowercase letters, numbers, or hyphens. Reserved names: \"default\", \"latest\", and any name with the prefix \"ah-\".",
@@ -4194,7 +4384,7 @@
},
"livenessCheck": {
"$ref": "LivenessCheck",
"description": "Configures liveness health checking for instances. Unhealthy instances are stopped and replaced with new instancesOnly returned in GET requests if view=FULL is set."
"description": "Configures liveness health checking for instances. Unhealthy instances are stopped and replaced with new instances"
},
"manualScaling": {
"$ref": "ManualScaling",
@@ -4214,7 +4404,7 @@
},
"readinessCheck": {
"$ref": "ReadinessCheck",
"description": "Configures readiness health checking for instances. Unhealthy instances are not put into the backend traffic rotation.Only returned in GET requests if view=FULL is set."
"description": "Configures readiness health checking for instances. Unhealthy instances are not put into the backend traffic rotation."
},
"resources": {
"$ref": "Resources",
@@ -4319,7 +4509,7 @@
"type": "string"
},
"name": {
"description": "Full Serverless VPC Access Connector name e.g. /projects/my-project/locations/us-central1/connectors/c1.",
"description": "Full Serverless VPC Access Connector name e.g. projects/my-project/locations/us-central1/connectors/c1.",
"type": "string"
}
},

0
etc/api/appengine/v1beta4/crates/5.0.4-api+20181005 Normal file
View File

0
etc/api/appengine/v1beta4/crates/5.0.4-cli+20181005 Normal file
View File

0
etc/api/appengine/v1beta5/crates/5.0.4-api+20181005 Normal file
View File

0
etc/api/appengine/v1beta5/crates/5.0.4-cli+20181005 Normal file
View File

0
etc/api/appsactivity/v1/crates/5.0.4-api+20200628 Normal file
View File

0
etc/api/appsactivity/v1/crates/5.0.4-cli+20200628 Normal file
View File

0
etc/api/appstate/v1/crates/5.0.4-api+20190627 Normal file
View File

0
etc/api/appstate/v1/crates/5.0.4-cli+20190627 Normal file
View File

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

@@ -586,7 +586,7 @@
}
}
},
"revision": "20230123",
"revision": "20240304",
"rootUrl": "https://area120tables.googleapis.com/",
"schemas": {
"BatchCreateRowsRequest": {

0
etc/api/area120tables/v1alpha1/crates/5.0.4-api+20240304 Normal file
View File

0
etc/api/area120tables/v1alpha1/crates/5.0.4-cli+20240304 Normal file
View File

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

File diff suppressed because it is too large Load Diff

0
etc/api/artifactregistry/v1/crates/5.0.4-api+20240213 Normal file
View File

0
etc/api/artifactregistry/v1/crates/5.0.4-cli+20240213 Normal file
View File

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

@@ -18,6 +18,13 @@
"description": "Store and manage build artifacts in a scalable and integrated service built on Google infrastructure.",
"discoveryVersion": "v1",
"documentationLink": "https://cloud.google.com/artifacts/docs/",
"endpoints": [
{
"description": "Regional Endpoint",
"endpointUrl": "https://artifactregistry.me-central2.rep.googleapis.com/",
"location": "me-central2"
}
],
"fullyEncodeReservedExpansion": true,
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
@@ -231,7 +238,7 @@
"type": "string"
},
"repositoryId": {
"description": "The repository id to use for this repository.",
"description": "Required. The repository id to use for this repository.",
"location": "query",
"type": "string"
}
@@ -377,7 +384,7 @@
],
"parameters": {
"name": {
"description": "The name of the repository, for example: \"projects/p1/locations/us-central1/repositories/repo1\".",
"description": "The name of the repository, for example: `projects/p1/locations/us-central1/repositories/repo1`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+$",
"required": true,
@@ -472,7 +479,7 @@
],
"parameters": {
"name": {
"description": "The name of the file to retrieve.",
"description": "Required. The name of the file to retrieve.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/files/.*$",
"required": true,
@@ -514,7 +521,7 @@
"type": "string"
},
"parent": {
"description": "The name of the repository whose files will be listed. For example: \"projects/p1/locations/us-central1/repositories/repo1",
"description": "Required. The name of the repository whose files will be listed. For example: \"projects/p1/locations/us-central1/repositories/repo1",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+$",
"required": true,
@@ -736,7 +743,7 @@
"type": "string"
},
"parent": {
"description": "The name of the parent resource whose tags will be listed.",
"description": "The name of the parent package whose tags will be listed. For example: `projects/p1/locations/us-central1/repositories/repo1/packages/pkg1`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/packages/[^/]+$",
"required": true,
@@ -929,7 +936,7 @@
}
}
},
"revision": "20230113",
"revision": "20240213",
"rootUrl": "https://artifactregistry.googleapis.com/",
"schemas": {
"Binding": {
@@ -941,14 +948,14 @@
"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 Google Cloud 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. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `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 Google Cloud 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. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `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. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.",
"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`.",
"description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).",
"type": "string"
}
},
@@ -988,8 +995,9 @@
"id": "File",
"properties": {
"createTime": {
"description": "The time when the File was created.",
"description": "Output only. The time when the File was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"hashes": {
@@ -1013,8 +1021,9 @@
"type": "string"
},
"updateTime": {
"description": "The time when the File was last updated.",
"description": "Output only. The time when the File was last updated.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
}
},
@@ -1155,7 +1164,7 @@
"type": "object"
},
"Location": {
"description": "A resource that represents Google Cloud Platform location.",
"description": "A resource that represents a Google Cloud location.",
"id": "Location",
"properties": {
"displayName": {
@@ -1217,7 +1226,7 @@
"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`.",
"description": "The normal, successful response of the operation. 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"
}
},
@@ -1237,7 +1246,7 @@
"type": "string"
},
"name": {
"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.",
"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": {
@@ -1249,7 +1258,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`, 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/).",
"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": {
@@ -1277,8 +1286,9 @@
"id": "Repository",
"properties": {
"createTime": {
"description": "The time when the repository was created.",
"description": "Output only. The time when the repository was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"description": {
@@ -1286,7 +1296,7 @@
"type": "string"
},
"format": {
"description": "The format of packages that are stored in the repository.",
"description": "Optional. The format of packages that are stored in the repository.",
"enum": [
"FORMAT_UNSPECIFIED",
"DOCKER",
@@ -1294,6 +1304,7 @@
"NPM",
"APT",
"YUM",
"GOOGET",
"PYTHON"
],
"enumDescriptions": [
@@ -1303,6 +1314,7 @@
"NPM package format.",
"APT package format.",
"YUM package format.",
"GooGet package format.",
"Python package format."
],
"type": "string"
@@ -1319,7 +1331,7 @@
"type": "object"
},
"name": {
"description": "The name of the repository, for example: \"projects/p1/locations/us-central1/repositories/repo1\".",
"description": "The name of the repository, for example: `projects/p1/locations/us-central1/repositories/repo1`.",
"type": "string"
},
"satisfiesPzs": {
@@ -1334,8 +1346,9 @@
"type": "string"
},
"updateTime": {
"description": "The time when the repository was last updated.",
"description": "Output only. The time when the repository was last updated.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
}
},

0
etc/api/artifactregistry/v1beta1/crates/5.0.4-api+20240213 Normal file
View File

0
etc/api/artifactregistry/v1beta1/crates/5.0.4-cli+20240213 Normal file
View File

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

@@ -18,6 +18,13 @@
"description": "Store and manage build artifacts in a scalable and integrated service built on Google infrastructure.",
"discoveryVersion": "v1",
"documentationLink": "https://cloud.google.com/artifacts/docs/",
"endpoints": [
{
"description": "Regional Endpoint",
"endpointUrl": "https://artifactregistry.me-central2.rep.googleapis.com/",
"location": "me-central2"
}
],
"fullyEncodeReservedExpansion": true,
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
@@ -293,7 +300,7 @@
"type": "string"
},
"repositoryId": {
"description": "The repository id to use for this repository.",
"description": "Required. The repository id to use for this repository.",
"location": "query",
"type": "string"
}
@@ -439,7 +446,7 @@
],
"parameters": {
"name": {
"description": "The name of the repository, for example: \"projects/p1/locations/us-central1/repositories/repo1\".",
"description": "The name of the repository, for example: `projects/p1/locations/us-central1/repositories/repo1`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+$",
"required": true,
@@ -606,7 +613,7 @@
],
"parameters": {
"name": {
"description": "The name of the file to retrieve.",
"description": "Required. The name of the file to retrieve.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/files/.*$",
"required": true,
@@ -648,7 +655,7 @@
"type": "string"
},
"parent": {
"description": "The name of the repository whose files will be listed. For example: \"projects/p1/locations/us-central1/repositories/repo1",
"description": "Required. The name of the repository whose files will be listed. For example: \"projects/p1/locations/us-central1/repositories/repo1",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+$",
"required": true,
@@ -870,7 +877,7 @@
"type": "string"
},
"parent": {
"description": "The name of the parent resource whose tags will be listed.",
"description": "The name of the parent package whose tags will be listed. For example: `projects/p1/locations/us-central1/repositories/repo1/packages/pkg1`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/packages/[^/]+$",
"required": true,
@@ -1135,7 +1142,7 @@
}
}
},
"revision": "20230113",
"revision": "20240213",
"rootUrl": "https://artifactregistry.googleapis.com/",
"schemas": {
"AptArtifact": {
@@ -1195,14 +1202,14 @@
"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 Google Cloud 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. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `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 Google Cloud 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. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `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. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.",
"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`.",
"description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).",
"type": "string"
}
},
@@ -1242,8 +1249,9 @@
"id": "GoogleDevtoolsArtifactregistryV1beta2File",
"properties": {
"createTime": {
"description": "The time when the File was created.",
"description": "Output only. The time when the File was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"hashes": {
@@ -1267,8 +1275,9 @@
"type": "string"
},
"updateTime": {
"description": "The time when the File was last updated.",
"description": "Output only. The time when the File was last updated.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
}
},
@@ -1551,7 +1560,7 @@
"type": "object"
},
"Location": {
"description": "A resource that represents Google Cloud Platform location.",
"description": "A resource that represents a Google Cloud location.",
"id": "Location",
"properties": {
"displayName": {
@@ -1638,7 +1647,7 @@
"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`.",
"description": "The normal, successful response of the operation. 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"
}
},
@@ -1664,7 +1673,7 @@
"type": "string"
},
"name": {
"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.",
"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": {
@@ -1676,7 +1685,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`, 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/).",
"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": {
@@ -1711,6 +1720,12 @@
"REDIRECTION_FROM_GCR_IO_ENABLED",
"REDIRECTION_FROM_GCR_IO_FINALIZED"
],
"enumDeprecated": [
false,
false,
false,
true
],
"enumDescriptions": [
"No redirection status has been set.",
"Redirection is disabled.",
@@ -1731,8 +1746,9 @@
"id": "Repository",
"properties": {
"createTime": {
"description": "The time when the repository was created.",
"description": "Output only. The time when the repository was created.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"description": {
@@ -1740,7 +1756,7 @@
"type": "string"
},
"format": {
"description": "The format of packages that are stored in the repository.",
"description": "Optional. The format of packages that are stored in the repository.",
"enum": [
"FORMAT_UNSPECIFIED",
"DOCKER",
@@ -1748,6 +1764,7 @@
"NPM",
"APT",
"YUM",
"GOOGET",
"PYTHON"
],
"enumDescriptions": [
@@ -1757,6 +1774,7 @@
"NPM package format.",
"APT package format.",
"YUM package format.",
"GooGet package format.",
"Python package format."
],
"type": "string"
@@ -1777,7 +1795,7 @@
"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\".",
"description": "The name of the repository, for example: `projects/p1/locations/us-central1/repositories/repo1`.",
"type": "string"
},
"satisfiesPzs": {
@@ -1792,8 +1810,9 @@
"type": "string"
},
"updateTime": {
"description": "The time when the repository was last updated.",
"description": "Output only. The time when the repository was last updated.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
}
},
@@ -1945,7 +1964,7 @@
"id": "UploadYumArtifactResponse",
"properties": {
"yumArtifacts": {
"description": "The Apt artifacts updated.",
"description": "The Yum artifacts updated.",
"items": {
"$ref": "YumArtifact"
},

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

@@ -137,7 +137,7 @@
]
},
"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.",
"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
"flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/operations",
"httpMethod": "GET",
"id": "assuredworkloads.organizations.locations.operations.list",
@@ -181,6 +181,53 @@
},
"workloads": {
"methods": {
"analyzeWorkloadMove": {
"description": "Analyzes a hypothetical move of a source resource to a target workload to surface compliance risks. The analysis is best effort and is not guaranteed to be exhaustive.",
"flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}:analyzeWorkloadMove",
"httpMethod": "GET",
"id": "assuredworkloads.organizations.locations.workloads.analyzeWorkloadMove",
"parameterOrder": [
"target"
],
"parameters": {
"assetTypes": {
"description": "Optional. List of asset types to be analyzed, including and under the source resource. If empty, all assets are analyzed. The complete list of asset types is available [here](https://cloud.google.com/asset-inventory/docs/supported-asset-types).",
"location": "query",
"repeated": true,
"type": "string"
},
"pageSize": {
"description": "Optional. Page size. If a value is not specified, the default value of 10 is used.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. The page token from the previous response. It needs to be passed in the second and following requests.",
"location": "query",
"type": "string"
},
"project": {
"description": "The source type is a project. Specify the project's relative resource name, formatted as either a project number or a project ID: \"projects/{PROJECT_NUMBER}\" or \"projects/{PROJECT_ID}\" For example: \"projects/951040570662\" when specifying a project number, or \"projects/my-project-123\" when specifying a project ID.",
"location": "query",
"type": "string"
},
"target": {
"description": "Required. The resource ID of the folder-based destination workload. This workload is where the source resource will hypothetically be moved to. Specify the workload's relative resource name, formatted as: \"organizations/{ORGANIZATION_ID}/locations/{LOCATION_ID}/workloads/{WORKLOAD_ID}\" For example: \"organizations/123/locations/us-east1/workloads/assured-workload-2\"",
"location": "path",
"pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+target}:analyzeWorkloadMove",
"response": {
"$ref": "GoogleCloudAssuredworkloadsV1AnalyzeWorkloadMoveResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"create": {
"description": "Creates Assured Workload.",
"flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/workloads",
@@ -215,7 +262,7 @@
]
},
"delete": {
"description": "Deletes the workload. Make sure that workload's direct children are already in a deleted state, otherwise the request will fail with a FAILED_PRECONDITION error.",
"description": "Deletes the workload. Make sure that workload's direct children are already in a deleted state, otherwise the request will fail with a FAILED_PRECONDITION error. In addition to assuredworkloads.workload.delete permission, the user should also have orgpolicy.policy.set permission on the deleted folder to remove Assured Workloads OrgPolicies.",
"flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}",
"httpMethod": "DELETE",
"id": "assuredworkloads.organizations.locations.workloads.delete",
@@ -244,6 +291,31 @@
"https://www.googleapis.com/auth/cloud-platform"
]
},
"enableResourceMonitoring": {
"description": "Enable resource violation monitoring for a workload.",
"flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}:enableResourceMonitoring",
"httpMethod": "POST",
"id": "assuredworkloads.organizations.locations.workloads.enableResourceMonitoring",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The `name` field is used to identify the workload. Format: organizations/{org_id}/locations/{location_id}/workloads/{workload_id}",
"location": "path",
"pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:enableResourceMonitoring",
"response": {
"$ref": "GoogleCloudAssuredworkloadsV1EnableResourceMonitoringResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets Assured Workload associated with a CRM Node",
"flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}",
@@ -254,7 +326,7 @@
],
"parameters": {
"name": {
"description": "Required. The resource name of the Workload to fetch. This is the workload's relative path in the API, formatted as \"organizations/{organization_id}/locations/{location_id}/workloads/{workload_id}\". For example, \"organizations/123/locations/us-east1/workloads/assured-workload-1\".",
"description": "Required. The resource name of the Workload to fetch. This is the workloads's relative path in the API, formatted as \"organizations/{organization_id}/locations/{location_id}/workloads/{workload_id}\". For example, \"organizations/123/locations/us-east1/workloads/assured-workload-1\".",
"location": "path",
"pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$",
"required": true,
@@ -519,18 +591,33 @@
}
}
},
"revision": "20230116",
"revision": "20240222",
"rootUrl": "https://assuredworkloads.googleapis.com/",
"schemas": {
"GoogleCloudAssuredworkloadsV1AcknowledgeViolationRequest": {
"description": "Request for acknowledging the violation Next Id: 4",
"description": "Request for acknowledging the violation",
"id": "GoogleCloudAssuredworkloadsV1AcknowledgeViolationRequest",
"properties": {
"acknowledgeType": {
"description": "Optional. Acknowledge type of specified violation.",
"enum": [
"ACKNOWLEDGE_TYPE_UNSPECIFIED",
"SINGLE_VIOLATION",
"EXISTING_CHILD_RESOURCE_VIOLATIONS"
],
"enumDescriptions": [
"Acknowledge type unspecified.",
"Acknowledge only the specific violation.",
"Acknowledge specified orgPolicy violation and also associated resource violations."
],
"type": "string"
},
"comment": {
"description": "Required. Business justification explaining the need for violation acknowledgement",
"type": "string"
},
"nonCompliantOrgPolicy": {
"deprecated": true,
"description": "Optional. This field is deprecated and will be removed in future version of the API. Name of the OrgPolicy which was modified with non-compliant change and resulted in this violation. Format: projects/{project_number}/policies/{constraint_name} folders/{folder_id}/policies/{constraint_name} organizations/{organization_id}/policies/{constraint_name}",
"type": "string"
}
@@ -543,6 +630,46 @@
"properties": {},
"type": "object"
},
"GoogleCloudAssuredworkloadsV1AnalyzeWorkloadMoveResponse": {
"description": "Response containing the analysis results for the hypothetical resource move.",
"id": "GoogleCloudAssuredworkloadsV1AnalyzeWorkloadMoveResponse",
"properties": {
"assetMoveAnalyses": {
"description": "List of analysis results for each asset in scope.",
"items": {
"$ref": "GoogleCloudAssuredworkloadsV1AssetMoveAnalysis"
},
"type": "array"
},
"nextPageToken": {
"description": "The next page token. Is empty if the last page is reached.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAssuredworkloadsV1AssetMoveAnalysis": {
"description": "Represents move analysis results for an asset.",
"id": "GoogleCloudAssuredworkloadsV1AssetMoveAnalysis",
"properties": {
"analysisGroups": {
"description": "List of eligible analyses performed for the asset.",
"items": {
"$ref": "GoogleCloudAssuredworkloadsV1MoveAnalysisGroup"
},
"type": "array"
},
"asset": {
"description": "The full resource name of the asset being analyzed. Example: //compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1",
"type": "string"
},
"assetType": {
"description": "Type of the asset being analyzed. Possible values will be among the ones listed [here](https://cloud.google.com/asset-inventory/docs/supported-asset-types).",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAssuredworkloadsV1CreateWorkloadOperationMetadata": {
"description": "Operation metadata to give request details of CreateWorkload.",
"id": "GoogleCloudAssuredworkloadsV1CreateWorkloadOperationMetadata",
@@ -563,7 +690,12 @@
"ITAR",
"AU_REGIONS_AND_US_SUPPORT",
"ASSURED_WORKLOADS_FOR_PARTNERS",
"ISR_REGIONS"
"ISR_REGIONS",
"ISR_REGIONS_AND_SUPPORT",
"CA_PROTECTED_B",
"IL5",
"IL2",
"JP_REGIONS_AND_SUPPORT"
],
"enumDescriptions": [
"Unknown compliance regime.",
@@ -577,9 +709,14 @@
"Assured Workloads For EU Regions and Support controls",
"Assured Workloads For Canada Regions and Support controls",
"International Traffic in Arms Regulations",
"Assured Workloads for Australia Regions and Support controls Available for public preview consumption. Don't create production workloads.",
"Assured Workloads for Partners",
"Assured Workloads for Israel Regions"
"Assured Workloads for Australia Regions and Support controls",
"Assured Workloads for Partners;",
"Assured Workloads for Israel",
"Assured Workloads for Israel Regions",
"Assured Workloads for Canada Protected B regime",
"Information protection as per DoD IL5 requirements.",
"Information protection as per DoD IL2 requirements.",
"Assured Workloads for Japan Regions"
],
"type": "string"
},
@@ -599,6 +736,12 @@
},
"type": "object"
},
"GoogleCloudAssuredworkloadsV1EnableResourceMonitoringResponse": {
"description": "Response for EnableResourceMonitoring endpoint.",
"id": "GoogleCloudAssuredworkloadsV1EnableResourceMonitoringResponse",
"properties": {},
"type": "object"
},
"GoogleCloudAssuredworkloadsV1ListViolationsResponse": {
"description": "Response of ListViolations endpoint.",
"id": "GoogleCloudAssuredworkloadsV1ListViolationsResponse",
@@ -635,8 +778,59 @@
},
"type": "object"
},
"GoogleCloudAssuredworkloadsV1MoveAnalysisGroup": {
"description": "Represents a logical group of checks performed for an asset. If successful, the group contains the analysis result, otherwise it contains an error with the failure reason.",
"id": "GoogleCloudAssuredworkloadsV1MoveAnalysisGroup",
"properties": {
"analysisResult": {
"$ref": "GoogleCloudAssuredworkloadsV1MoveAnalysisResult",
"description": "Result of a successful analysis."
},
"displayName": {
"description": "Name of the analysis group.",
"type": "string"
},
"error": {
"$ref": "GoogleRpcStatus",
"description": "Error details for a failed analysis."
}
},
"type": "object"
},
"GoogleCloudAssuredworkloadsV1MoveAnalysisResult": {
"description": "Represents the successful move analysis results for a group.",
"id": "GoogleCloudAssuredworkloadsV1MoveAnalysisResult",
"properties": {
"blockers": {
"description": "List of blockers. If not resolved, these will result in compliance violations in the target.",
"items": {
"$ref": "GoogleCloudAssuredworkloadsV1MoveImpact"
},
"type": "array"
},
"warnings": {
"description": "List of warnings. These are risks that may or may not result in compliance violations.",
"items": {
"$ref": "GoogleCloudAssuredworkloadsV1MoveImpact"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudAssuredworkloadsV1MoveImpact": {
"description": "Represents the impact of moving the asset to the target.",
"id": "GoogleCloudAssuredworkloadsV1MoveImpact",
"properties": {
"detail": {
"description": "Explanation of the impact.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAssuredworkloadsV1MutatePartnerPermissionsRequest": {
"description": "Request of updating permission settings for a partner workload.",
"description": "Request for updating permission settings for a partner workload.",
"id": "GoogleCloudAssuredworkloadsV1MutatePartnerPermissionsRequest",
"properties": {
"etag": {
@@ -671,7 +865,7 @@
"Unknown restriction type.",
"Allow the use all of all gcp products, irrespective of the compliance posture. This effectively removes gcp.restrictServiceUsage OrgPolicy on the AssuredWorkloads Folder.",
"Based on Workload's compliance regime, allowed list changes. See - https://cloud.google.com/assured-workloads/docs/supported-products for the list of supported resources.",
"Similar to ALLOW_COMPLIANT_RESOURCES but adds the list of compliant resources to the existing list of resources. Effective org-policy of the Folder is considered to ensure there is no disruption to the existing customer workflows."
"Similar to ALLOW_COMPLIANT_RESOURCES but adds the list of compliant resources to the existing list of compliant resources. Effective org-policy of the Folder is considered to ensure there is no disruption to the existing customer workflows."
],
"type": "string"
}
@@ -685,7 +879,7 @@
"type": "object"
},
"GoogleCloudAssuredworkloadsV1Violation": {
"description": "Workload monitoring Violation. Next Id: 22",
"description": "Workload monitoring Violation.",
"id": "GoogleCloudAssuredworkloadsV1Violation",
"properties": {
"acknowledged": {
@@ -693,10 +887,15 @@
"type": "boolean"
},
"acknowledgementTime": {
"description": "Optional. Timestamp when this violation was acknowledged last. This will be absent when acknowledged field is marked as false.",
"description": "Optional. Timestamp when this violation was acknowledged first. Check exception_contexts to find the last time the violation was acknowledged when there are more than one violations. This field will be absent when acknowledged field is marked as false.",
"format": "google-datetime",
"type": "string"
},
"associatedOrgPolicyViolationId": {
"description": "Optional. Output only. Violation Id of the org-policy violation due to which the resource violation is caused. Empty for org-policy violations.",
"readOnly": true,
"type": "string"
},
"auditLogLink": {
"description": "Output only. Immutable. Audit Log Link for violated resource Format: https://console.cloud.google.com/logs/query;query={logName}{protoPayload.resourceName}{timeRange}{folder}",
"readOnly": true,
@@ -723,6 +922,14 @@
"readOnly": true,
"type": "string"
},
"exceptionContexts": {
"description": "Output only. List of all the exception detail added for the violation.",
"items": {
"$ref": "GoogleCloudAssuredworkloadsV1ViolationExceptionContext"
},
"readOnly": true,
"type": "array"
},
"name": {
"description": "Output only. Immutable. Name of the Violation. Format: organizations/{organization}/locations/{location}/workloads/{workload_id}/violations/{violations_id}",
"readOnly": true,
@@ -734,10 +941,16 @@
"type": "string"
},
"orgPolicyConstraint": {
"deprecated": true,
"description": "Output only. Immutable. The org-policy-constraint that was incorrectly changed, which resulted in this violation.",
"readOnly": true,
"type": "string"
},
"parentProjectNumber": {
"description": "Optional. Output only. Parent project number where resource is present. Empty for org-policy violations.",
"readOnly": true,
"type": "string"
},
"remediation": {
"$ref": "GoogleCloudAssuredworkloadsV1ViolationRemediation",
"description": "Output only. Compliance violation remediation",
@@ -749,6 +962,16 @@
"readOnly": true,
"type": "string"
},
"resourceName": {
"description": "Optional. Output only. Name of the resource like //storage.googleapis.com/myprojectxyz-testbucket. Empty for org-policy violations.",
"readOnly": true,
"type": "string"
},
"resourceType": {
"description": "Optional. Output only. Type of the resource like compute.googleapis.com/Disk, etc. Empty for org-policy violations.",
"readOnly": true,
"type": "string"
},
"state": {
"description": "Output only. State of the violation",
"enum": [
@@ -771,6 +994,41 @@
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"violationType": {
"description": "Output only. Type of the violation",
"enum": [
"VIOLATION_TYPE_UNSPECIFIED",
"ORG_POLICY",
"RESOURCE"
],
"enumDescriptions": [
"Unspecified type.",
"Org Policy Violation.",
"Resource Violation."
],
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAssuredworkloadsV1ViolationExceptionContext": {
"description": "Violation exception detail.",
"id": "GoogleCloudAssuredworkloadsV1ViolationExceptionContext",
"properties": {
"acknowledgementTime": {
"description": "Timestamp when the violation was acknowledged.",
"format": "google-datetime",
"type": "string"
},
"comment": {
"description": "Business justification provided towards the acknowledgement of the violation.",
"type": "string"
},
"userName": {
"description": "Name of the user (or service account) who acknowledged the violation.",
"type": "string"
}
},
"type": "object"
@@ -797,14 +1055,16 @@
"REMEDIATION_BOOLEAN_ORG_POLICY_VIOLATION",
"REMEDIATION_LIST_ALLOWED_VALUES_ORG_POLICY_VIOLATION",
"REMEDIATION_LIST_DENIED_VALUES_ORG_POLICY_VIOLATION",
"REMEDIATION_RESTRICT_CMEK_CRYPTO_KEY_PROJECTS_ORG_POLICY_VIOLATION"
"REMEDIATION_RESTRICT_CMEK_CRYPTO_KEY_PROJECTS_ORG_POLICY_VIOLATION",
"REMEDIATION_RESOURCE_VIOLATION"
],
"enumDescriptions": [
"Unspecified remediation type",
"Remediation type for boolean org policy",
"Remediation type for list org policy which have allowed values in the monitoring rule",
"Remediation type for list org policy which have denied values in the monitoring rule",
"Remediation type for gcp.restrictCmekCryptoKeyProjects"
"Remediation type for gcp.restrictCmekCryptoKeyProjects",
"Remediation type for resource violation."
],
"readOnly": true,
"type": "string"
@@ -907,7 +1167,12 @@
"ITAR",
"AU_REGIONS_AND_US_SUPPORT",
"ASSURED_WORKLOADS_FOR_PARTNERS",
"ISR_REGIONS"
"ISR_REGIONS",
"ISR_REGIONS_AND_SUPPORT",
"CA_PROTECTED_B",
"IL5",
"IL2",
"JP_REGIONS_AND_SUPPORT"
],
"enumDescriptions": [
"Unknown compliance regime.",
@@ -921,9 +1186,14 @@
"Assured Workloads For EU Regions and Support controls",
"Assured Workloads For Canada Regions and Support controls",
"International Traffic in Arms Regulations",
"Assured Workloads for Australia Regions and Support controls Available for public preview consumption. Don't create production workloads.",
"Assured Workloads for Partners",
"Assured Workloads for Israel Regions"
"Assured Workloads for Australia Regions and Support controls",
"Assured Workloads for Partners;",
"Assured Workloads for Israel",
"Assured Workloads for Israel Regions",
"Assured Workloads for Canada Protected B regime",
"Information protection as per DoD IL5 requirements.",
"Information protection as per DoD IL2 requirements.",
"Assured Workloads for Japan Regions"
],
"type": "string"
},
@@ -933,7 +1203,7 @@
"readOnly": true
},
"compliantButDisallowedServices": {
"description": "Output only. Urls for services which are compliant for this Assured Workload, but which are currently disallowed by the ResourceUsageRestriction org policy. Invoke RestrictAllowedResources endpoint to allow your project developers to use these services in their environment.\"",
"description": "Output only. Urls for services which are compliant for this Assured Workload, but which are currently disallowed by the ResourceUsageRestriction org policy. Invoke RestrictAllowedResources endpoint to allow your project developers to use these services in their environment.",
"items": {
"type": "string"
},
@@ -950,6 +1220,11 @@
"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"
},
"ekmProvisioningResponse": {
"$ref": "GoogleCloudAssuredworkloadsV1WorkloadEkmProvisioningResponse",
"description": "Output only. Represents the Ekm Provisioning State of the given workload.",
"readOnly": true
},
"enableSovereignControls": {
"description": "Optional. Indicates the sovereignty status of the given workload. Currently meant to be used by Europe/Canada customers.",
"type": "boolean"
@@ -975,6 +1250,7 @@
},
"kmsSettings": {
"$ref": "GoogleCloudAssuredworkloadsV1WorkloadKMSSettings",
"deprecated": true,
"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": {
@@ -993,19 +1269,32 @@
"enum": [
"PARTNER_UNSPECIFIED",
"LOCAL_CONTROLS_BY_S3NS",
"SOVEREIGN_CONTROLS_BY_T_SYSTEMS"
"SOVEREIGN_CONTROLS_BY_T_SYSTEMS",
"SOVEREIGN_CONTROLS_BY_SIA_MINSAIT",
"SOVEREIGN_CONTROLS_BY_PSN"
],
"enumDescriptions": [
"",
"Enum representing S3NS partner.",
"Enum representing T_SYSTEM partner."
"Enum representing S3NS (Thales) partner.",
"Enum representing T_SYSTEM (TSI) partner.",
"Enum representing SIA_MINSAIT (Indra) partner.",
"Enum representing PSN (TIM) partner."
],
"type": "string"
},
"partnerPermissions": {
"$ref": "GoogleCloudAssuredworkloadsV1WorkloadPartnerPermissions",
"description": "Optional. Permissions granted to the AW Partner SA account for the customer workload"
},
"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"
},
"resourceMonitoringEnabled": {
"description": "Output only. Indicates whether resource monitoring is enabled for workload or not. It is true when Resource feed is subscribed to AWM topic and AWM Service Agent Role is binded to AW Service Account for resource Assured workload.",
"readOnly": true,
"type": "boolean"
},
"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": {
@@ -1025,6 +1314,10 @@
"$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
},
"violationNotificationsEnabled": {
"description": "Optional. Indicates whether the e-mail notification for a violation is enabled for a workload. This value will be by default True, and if not present will be considered as true. This should only be updated via updateWorkload call. Any Changes to this field during the createWorkload call will not be honored. This will always be true while creating the workload.",
"type": "boolean"
}
},
"type": "object"
@@ -1033,21 +1326,91 @@
"description": "Represents the Compliance Status of this workload",
"id": "GoogleCloudAssuredworkloadsV1WorkloadComplianceStatus",
"properties": {
"acknowledgedResourceViolationCount": {
"description": "Number of current resource violations which are not acknowledged.",
"format": "int32",
"type": "integer"
},
"acknowledgedViolationCount": {
"description": "Count of active Violations which are acknowledged in the Workload.",
"description": "Number of current orgPolicy violations which are acknowledged.",
"format": "int32",
"type": "integer"
},
"activeResourceViolationCount": {
"description": "Number of current resource violations which are acknowledged.",
"format": "int32",
"type": "integer"
},
"activeViolationCount": {
"description": "Count of active Violations which haven't been acknowledged.",
"description": "Number of current orgPolicy violations which are not acknowledged.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleCloudAssuredworkloadsV1WorkloadEkmProvisioningResponse": {
"description": "External key management systems(EKM) Provisioning response",
"id": "GoogleCloudAssuredworkloadsV1WorkloadEkmProvisioningResponse",
"properties": {
"ekmProvisioningErrorDomain": {
"description": "Indicates Ekm provisioning error if any.",
"enum": [
"EKM_PROVISIONING_ERROR_DOMAIN_UNSPECIFIED",
"UNSPECIFIED_ERROR",
"GOOGLE_SERVER_ERROR",
"EXTERNAL_USER_ERROR",
"EXTERNAL_PARTNER_ERROR",
"TIMEOUT_ERROR"
],
"enumDescriptions": [
"No error domain",
"Error but domain is unspecified.",
"Internal logic breaks within provisioning code.",
"Error occurred with the customer not granting permission/creating resource.",
"Error occurred within the partner's provisioning cluster.",
"Resource wasn't provisioned in the required 7 day time period"
],
"type": "string"
},
"ekmProvisioningErrorMapping": {
"description": "Detailed error message if Ekm provisioning fails",
"enum": [
"EKM_PROVISIONING_ERROR_MAPPING_UNSPECIFIED",
"INVALID_SERVICE_ACCOUNT",
"MISSING_METRICS_SCOPE_ADMIN_PERMISSION",
"MISSING_EKM_CONNECTION_ADMIN_PERMISSION"
],
"enumDescriptions": [
"Error is unspecified.",
"Service account is used is invalid.",
"Iam permission monitoring.MetricsScopeAdmin wasn't applied.",
"Iam permission cloudkms.ekmConnectionsAdmin wasn't applied."
],
"type": "string"
},
"ekmProvisioningState": {
"description": "Indicates Ekm enrollment Provisioning of a given workload.",
"enum": [
"EKM_PROVISIONING_STATE_UNSPECIFIED",
"EKM_PROVISIONING_STATE_PENDING",
"EKM_PROVISIONING_STATE_FAILED",
"EKM_PROVISIONING_STATE_COMPLETED"
],
"enumDescriptions": [
"Default State for Ekm Provisioning",
"Pending State for Ekm Provisioning",
"Failed State for Ekm Provisioning",
"Completed State for Ekm Provisioning"
],
"type": "string"
}
},
"type": "object"
},
"GoogleCloudAssuredworkloadsV1WorkloadKMSSettings": {
"description": "Settings specific to the Key Management Service. This message is deprecated. In order to create a Keyring, callers should specify, ENCRYPTION_KEYS_PROJECT or KEYRING in ResourceSettings.resource_type field.",
"deprecated": true,
"description": "Settings specific to the Key Management Service.",
"id": "GoogleCloudAssuredworkloadsV1WorkloadKMSSettings",
"properties": {
"nextRotationTime": {
@@ -1067,16 +1430,16 @@
"description": "Permissions granted to the AW Partner SA account for the customer workload",
"id": "GoogleCloudAssuredworkloadsV1WorkloadPartnerPermissions",
"properties": {
"dataLogsViewer": {
"description": "Allow partner to view data and logs",
"assuredWorkloadsMonitoring": {
"description": "Optional. Allow partner to view violation alerts.",
"type": "boolean"
},
"remediateFolderViolations": {
"description": "Allow partner to monitor folder and remediate violations",
"dataLogsViewer": {
"description": "Allow the partner to view inspectability logs and monitoring violations.",
"type": "boolean"
},
"serviceAccessApprover": {
"description": "Allow partner to approve or reject Service Access requests",
"description": "Optional. Allow partner to view access approval logs.",
"type": "boolean"
}
},
@@ -1100,9 +1463,16 @@
"ENCRYPTION_KEYS_PROJECT",
"KEYRING"
],
"enumDeprecated": [
false,
true,
false,
false,
false
],
"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.",
"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."
@@ -1125,7 +1495,7 @@
"type": "string"
},
"resourceType": {
"description": "Indicates the type of resource. This field should be specified to correspond the id to the right resource type (CONSUMER_FOLDER or ENCRYPTION_KEYS_PROJECT)",
"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",
@@ -1133,9 +1503,16 @@
"ENCRYPTION_KEYS_PROJECT",
"KEYRING"
],
"enumDeprecated": [
false,
true,
false,
false,
false
],
"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.",
"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."
@@ -1234,7 +1611,7 @@
"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`.",
"description": "The normal, successful response of the operation. 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"
}
},

0
etc/api/assuredworkloads/v1/crates/5.0.4-api+20240222 Normal file
View File

0
etc/api/assuredworkloads/v1/crates/5.0.4-cli+20240222 Normal file
View File

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