From 9f30db4e832cd1369273d7b9342fc7247029ba0a Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 19 Jul 2022 07:08:08 +0000 Subject: [PATCH 01/23] feat(apigeeregistry): update the api #### apigeeregistry:v1 The following keys were added: - resources.projects.resources.locations.resources.apis.methods.delete.parameters.force (Total Keys: 2) - resources.projects.resources.locations.resources.apis.resources.versions.methods.delete.parameters.force (Total Keys: 2) --- .../apigeeregistry_v1.projects.locations.apis.html | 5 +++-- ...registry_v1.projects.locations.apis.versions.html | 5 +++-- .../discovery_cache/documents/apigeeregistry.v1.json | 12 +++++++++++- 3 files changed, 17 insertions(+), 5 deletions(-) diff --git a/docs/dyn/apigeeregistry_v1.projects.locations.apis.html b/docs/dyn/apigeeregistry_v1.projects.locations.apis.html index be53e0d7411..358a8e1bdd8 100644 --- a/docs/dyn/apigeeregistry_v1.projects.locations.apis.html +++ b/docs/dyn/apigeeregistry_v1.projects.locations.apis.html @@ -96,7 +96,7 @@

Instance Methods

create(parent, apiId=None, body=None, x__xgafv=None)

CreateApi creates a specified API.

- delete(name, x__xgafv=None)

+ delete(name, force=None, x__xgafv=None)

DeleteApi removes a specified API and all of the resources that it owns.

get(name, x__xgafv=None)

@@ -179,11 +179,12 @@

Method Details

- delete(name, x__xgafv=None) + delete(name, force=None, x__xgafv=None)
DeleteApi removes a specified API and all of the resources that it owns.
 
 Args:
   name: string, Required. The name of the API to delete. Format: projects/*/locations/*/apis/* (required)
+  force: boolean, If set to true, any child resources will also be deleted. (Otherwise, the request will only work if there are no child resources.)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
diff --git a/docs/dyn/apigeeregistry_v1.projects.locations.apis.versions.html b/docs/dyn/apigeeregistry_v1.projects.locations.apis.versions.html
index af46061ecfd..ffed8c0863c 100644
--- a/docs/dyn/apigeeregistry_v1.projects.locations.apis.versions.html
+++ b/docs/dyn/apigeeregistry_v1.projects.locations.apis.versions.html
@@ -91,7 +91,7 @@ 

Instance Methods

create(parent, apiVersionId=None, body=None, x__xgafv=None)

CreateApiVersion creates a specified version.

- delete(name, x__xgafv=None)

+ delete(name, force=None, x__xgafv=None)

DeleteApiVersion removes a specified version and all of the resources that it owns.

get(name, x__xgafv=None)

@@ -170,11 +170,12 @@

Method Details

- delete(name, x__xgafv=None) + delete(name, force=None, x__xgafv=None)
DeleteApiVersion removes a specified version and all of the resources that it owns.
 
 Args:
   name: string, Required. The name of the version to delete. Format: projects/*/locations/*/apis/*/versions/* (required)
+  force: boolean, If set to true, any child resources will also be deleted. (Otherwise, the request will only work if there are no child resources.)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
diff --git a/googleapiclient/discovery_cache/documents/apigeeregistry.v1.json b/googleapiclient/discovery_cache/documents/apigeeregistry.v1.json
index c5c15e9fb32..6183e2e56a8 100644
--- a/googleapiclient/discovery_cache/documents/apigeeregistry.v1.json
+++ b/googleapiclient/discovery_cache/documents/apigeeregistry.v1.json
@@ -221,6 +221,11 @@
                     "name"
                   ],
                   "parameters": {
+                    "force": {
+                      "description": "If set to true, any child resources will also be deleted. (Otherwise, the request will only work if there are no child resources.)",
+                      "location": "query",
+                      "type": "boolean"
+                    },
                     "name": {
                       "description": "Required. The name of the API to delete. Format: projects/*/locations/*/apis/*",
                       "location": "path",
@@ -1302,6 +1307,11 @@
                         "name"
                       ],
                       "parameters": {
+                        "force": {
+                          "description": "If set to true, any child resources will also be deleted. (Otherwise, the request will only work if there are no child resources.)",
+                          "location": "query",
+                          "type": "boolean"
+                        },
                         "name": {
                           "description": "Required. The name of the version to delete. Format: projects/*/locations/*/apis/*/versions/*",
                           "location": "path",
@@ -3116,7 +3126,7 @@
       }
     }
   },
-  "revision": "20220615",
+  "revision": "20220706",
   "rootUrl": "https://apigeeregistry.googleapis.com/",
   "schemas": {
     "Api": {

From 166131a38dd2a09ed8005e6ace9227194ae013f2 Mon Sep 17 00:00:00 2001
From: Yoshi Automation 
Date: Tue, 19 Jul 2022 07:08:09 +0000
Subject: [PATCH 02/23] feat(bigtableadmin): update the api

#### bigtableadmin:v2

The following keys were added:
- schemas.Instance.properties.satisfiesPzs (Total Keys: 2)
---
 docs/dyn/bigtableadmin_v2.projects.instances.html          | 6 ++++++
 .../discovery_cache/documents/bigtableadmin.v2.json        | 7 ++++++-
 2 files changed, 12 insertions(+), 1 deletion(-)

diff --git a/docs/dyn/bigtableadmin_v2.projects.instances.html b/docs/dyn/bigtableadmin_v2.projects.instances.html
index 436a48ce09d..5a99a4cc5b0 100644
--- a/docs/dyn/bigtableadmin_v2.projects.instances.html
+++ b/docs/dyn/bigtableadmin_v2.projects.instances.html
@@ -169,6 +169,7 @@ 

Method Details

"a_key": "A String", }, "name": "A String", # The unique name of the instance. Values are of the form `projects/{project}/instances/a-z+[a-z0-9]`. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "state": "A String", # Output only. The current state of the instance. "type": "A String", # Required. The type of the instance. Defaults to `PRODUCTION`. }, @@ -244,6 +245,7 @@

Method Details

"a_key": "A String", }, "name": "A String", # The unique name of the instance. Values are of the form `projects/{project}/instances/a-z+[a-z0-9]`. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "state": "A String", # Output only. The current state of the instance. "type": "A String", # Required. The type of the instance. Defaults to `PRODUCTION`. }
@@ -332,6 +334,7 @@

Method Details

"a_key": "A String", }, "name": "A String", # The unique name of the instance. Values are of the form `projects/{project}/instances/a-z+[a-z0-9]`. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "state": "A String", # Output only. The current state of the instance. "type": "A String", # Required. The type of the instance. Defaults to `PRODUCTION`. }, @@ -370,6 +373,7 @@

Method Details

"a_key": "A String", }, "name": "A String", # The unique name of the instance. Values are of the form `projects/{project}/instances/a-z+[a-z0-9]`. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "state": "A String", # Output only. The current state of the instance. "type": "A String", # Required. The type of the instance. Defaults to `PRODUCTION`. } @@ -535,6 +539,7 @@

Method Details

"a_key": "A String", }, "name": "A String", # The unique name of the instance. Values are of the form `projects/{project}/instances/a-z+[a-z0-9]`. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "state": "A String", # Output only. The current state of the instance. "type": "A String", # Required. The type of the instance. Defaults to `PRODUCTION`. } @@ -554,6 +559,7 @@

Method Details

"a_key": "A String", }, "name": "A String", # The unique name of the instance. Values are of the form `projects/{project}/instances/a-z+[a-z0-9]`. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "state": "A String", # Output only. The current state of the instance. "type": "A String", # Required. The type of the instance. Defaults to `PRODUCTION`. } diff --git a/googleapiclient/discovery_cache/documents/bigtableadmin.v2.json b/googleapiclient/discovery_cache/documents/bigtableadmin.v2.json index ff1808f5d56..385c6fc811f 100644 --- a/googleapiclient/discovery_cache/documents/bigtableadmin.v2.json +++ b/googleapiclient/discovery_cache/documents/bigtableadmin.v2.json @@ -1892,7 +1892,7 @@ } } }, - "revision": "20220701", + "revision": "20220706", "rootUrl": "https://bigtableadmin.googleapis.com/", "schemas": { "AppProfile": { @@ -2629,6 +2629,11 @@ "description": "The unique name of the instance. Values are of the form `projects/{project}/instances/a-z+[a-z0-9]`.", "type": "string" }, + "satisfiesPzs": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, "state": { "description": "Output only. The current state of the instance.", "enum": [ From 318a536b3032d299194439a47fff3ae5a7b7201c Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 19 Jul 2022 07:08:09 +0000 Subject: [PATCH 03/23] feat(certificatemanager): update the api #### certificatemanager:v1 The following keys were deleted: - schemas.ResourcesCount (Total Keys: 7) --- .../documents/certificatemanager.v1.json | 23 +------------------ 1 file changed, 1 insertion(+), 22 deletions(-) diff --git a/googleapiclient/discovery_cache/documents/certificatemanager.v1.json b/googleapiclient/discovery_cache/documents/certificatemanager.v1.json index efd14dcdf7c..234c4087bba 100644 --- a/googleapiclient/discovery_cache/documents/certificatemanager.v1.json +++ b/googleapiclient/discovery_cache/documents/certificatemanager.v1.json @@ -975,7 +975,7 @@ } } }, - "revision": "20220621", + "revision": "20220707", "rootUrl": "https://certificatemanager.googleapis.com/", "schemas": { "AuthorizationAttemptInfo": { @@ -1648,27 +1648,6 @@ }, "type": "object" }, - "ResourcesCount": { - "description": "ResourcesCount represents the resource that stores aggregated project's info in the given location, e.g.: total number of certificates assigned to the project.", - "id": "ResourcesCount", - "properties": { - "certificates": { - "description": "The count of certificates.", - "format": "uint64", - "type": "string" - }, - "computeTime": { - "description": "Required. Input only. The time of the computation. The field is input only, used in Create and Update calls. For Update call, new values of selected resources are set if their compute_time is younger than the persisted ones, e.g.: If you support 3 types of resources: A, B and C, and you have: 'A' resource count computed at timestamp = 3 'B' resource count computed at timestamp = 10 'C' resource count computed at timestamp = 5 And you're going to update all of them with compute_time = 8, only 'A' and 'C' will be updated, as 'B' already has fresher data. For Get call a ResourcesCount instance contains the freshest values for every type.", - "format": "google-datetime", - "type": "string" - }, - "name": { - "description": "The singleton resource of the resources count. Must be in the format `projects/*/locations/*/resourcesCounts/single`.", - "type": "string" - } - }, - "type": "object" - }, "SelfManagedCertificate": { "description": "Certificate data for a SelfManaged Certificate. SelfManaged Certificates are uploaded by the user. Updating such certificates before they expire remains the user's responsibility.", "id": "SelfManagedCertificate", From b5bb878f4559ba796ac1ec1624f0c27ae1e74a91 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 19 Jul 2022 07:08:09 +0000 Subject: [PATCH 04/23] feat(chromemanagement): update the api #### chromemanagement:v1 The following keys were added: - resources.customers.resources.reports.methods.countChromeDevicesReachingAutoExpirationDate (Total Keys: 17) - resources.customers.resources.reports.methods.countChromeDevicesThatNeedAttention (Total Keys: 16) - schemas.GoogleChromeManagementV1CountChromeDevicesReachingAutoExpirationDateResponse (Total Keys: 4) - schemas.GoogleChromeManagementV1CountChromeDevicesThatNeedAttentionResponse (Total Keys: 12) - schemas.GoogleChromeManagementV1DeviceAueCountReport (Total Keys: 9) --- ...chromemanagement_v1.customers.reports.html | 61 ++++++ .../documents/chromemanagement.v1.json | 183 +++++++++++++++++- 2 files changed, 243 insertions(+), 1 deletion(-) diff --git a/docs/dyn/chromemanagement_v1.customers.reports.html b/docs/dyn/chromemanagement_v1.customers.reports.html index 9eaaebe7b7d..15f433a92aa 100644 --- a/docs/dyn/chromemanagement_v1.customers.reports.html +++ b/docs/dyn/chromemanagement_v1.customers.reports.html @@ -77,6 +77,12 @@

Instance Methods

close()

Close httplib2 connections.

+

+ countChromeDevicesReachingAutoExpirationDate(customer, maxAueDate=None, minAueDate=None, orgUnitId=None, x__xgafv=None)

+

Generate report of the number of devices expiring in each month of the selected time frame. Devices are grouped by auto update expiration date and model. Further information can be found [here](https://support.google.com/chrome/a/answer/10564947).

+

+ countChromeDevicesThatNeedAttention(customer, orgUnitId=None, readMask=None, x__xgafv=None)

+

Counts of ChromeOS devices that have not synced policies or have lacked user activity in the past 28 days, are out of date, or are not complaint. Further information can be found here https://support.google.com/chrome/a/answer/10564947

countChromeVersions(customer, filter=None, orgUnitId=None, pageSize=None, pageToken=None, x__xgafv=None)

Generate report of installed Chrome versions.

@@ -101,6 +107,61 @@

Method Details

Close httplib2 connections.
+
+ countChromeDevicesReachingAutoExpirationDate(customer, maxAueDate=None, minAueDate=None, orgUnitId=None, x__xgafv=None) +
Generate report of the number of devices expiring in each month of the selected time frame. Devices are grouped by auto update expiration date and model. Further information can be found [here](https://support.google.com/chrome/a/answer/10564947).
+
+Args:
+  customer: string, Required. The customer ID or "my_customer" prefixed with "customers/". (required)
+  maxAueDate: string, Optional. Maximum expiration date in format yyyy-mm-dd in UTC timezone. If included returns all devices that have already expired and devices with auto expiration date equal to or earlier than the maximum date.
+  minAueDate: string, Optional. Maximum expiration date in format yyyy-mm-dd in UTC timezone. If included returns all devices that have already expired and devices with auto expiration date equal to or later than the minimum date.
+  orgUnitId: string, Optional. The organizational unit ID, if omitted, will return data for all organizational units.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response containing a list of devices expiring in each month of a selected time frame. Counts are grouped by model and Auto Update Expiration date.
+  "deviceAueCountReports": [ # The list of reports sorted by auto update expiration date in ascending order.
+    { # Report for CountChromeDevicesPerAueDateResponse, contains the count of devices of a specific model and auto update expiration range.
+      "aueMonth": "A String", # Enum value of month corresponding to the auto update expiration date in UTC time zone. If the device is already expired, this field is empty.
+      "aueYear": "A String", # Int value of year corresponding to the Auto Update Expiration date in UTC time zone. If the device is already expired, this field is empty.
+      "count": "A String", # Count of devices of this model.
+      "expired": True or False, # Boolean value for whether or not the device has already expired.
+      "model": "A String", # Public model name of the devices.
+    },
+  ],
+}
+
+ +
+ countChromeDevicesThatNeedAttention(customer, orgUnitId=None, readMask=None, x__xgafv=None) +
Counts of ChromeOS devices that have not synced policies or have lacked user activity in the past 28 days, are out of date, or are not complaint. Further information can be found here https://support.google.com/chrome/a/answer/10564947
+
+Args:
+  customer: string, Required. The customer ID or "my_customer" prefixed with "customers/". (required)
+  orgUnitId: string, Optional. The ID of the organizational unit. If omitted, all data will be returned.
+  readMask: string, Required. Mask of the fields that should be populated in the returned report.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response containing counts for devices that need attention.
+  "noRecentPolicySyncCount": "A String", # Number of ChromeOS devices have not synced policies in the past 28 days.
+  "noRecentUserActivityCount": "A String", # Number of ChromeOS devices that have not seen any user activity in the past 28 days.
+  "osVersionNotCompliantCount": "A String", # Number of devices whose OS version is not compliant.
+  "pendingUpdate": "A String", # Number of devices that are pending an OS update.
+  "unsupportedPolicyCount": "A String", # Number of devices that are unable to apply a policy due to an OS version mismatch.
+}
+
+
countChromeVersions(customer, filter=None, orgUnitId=None, pageSize=None, pageToken=None, x__xgafv=None)
Generate report of installed Chrome versions.
diff --git a/googleapiclient/discovery_cache/documents/chromemanagement.v1.json b/googleapiclient/discovery_cache/documents/chromemanagement.v1.json
index 4e03c664131..9cc0b786045 100644
--- a/googleapiclient/discovery_cache/documents/chromemanagement.v1.json
+++ b/googleapiclient/discovery_cache/documents/chromemanagement.v1.json
@@ -254,6 +254,82 @@
         },
         "reports": {
           "methods": {
+            "countChromeDevicesReachingAutoExpirationDate": {
+              "description": "Generate report of the number of devices expiring in each month of the selected time frame. Devices are grouped by auto update expiration date and model. Further information can be found [here](https://support.google.com/chrome/a/answer/10564947).",
+              "flatPath": "v1/customers/{customersId}/reports:countChromeDevicesReachingAutoExpirationDate",
+              "httpMethod": "GET",
+              "id": "chromemanagement.customers.reports.countChromeDevicesReachingAutoExpirationDate",
+              "parameterOrder": [
+                "customer"
+              ],
+              "parameters": {
+                "customer": {
+                  "description": "Required. The customer ID or \"my_customer\" prefixed with \"customers/\".",
+                  "location": "path",
+                  "pattern": "^customers/[^/]+$",
+                  "required": true,
+                  "type": "string"
+                },
+                "maxAueDate": {
+                  "description": "Optional. Maximum expiration date in format yyyy-mm-dd in UTC timezone. If included returns all devices that have already expired and devices with auto expiration date equal to or earlier than the maximum date.",
+                  "location": "query",
+                  "type": "string"
+                },
+                "minAueDate": {
+                  "description": "Optional. Maximum expiration date in format yyyy-mm-dd in UTC timezone. If included returns all devices that have already expired and devices with auto expiration date equal to or later than the minimum date.",
+                  "location": "query",
+                  "type": "string"
+                },
+                "orgUnitId": {
+                  "description": "Optional. The organizational unit ID, if omitted, will return data for all organizational units.",
+                  "location": "query",
+                  "type": "string"
+                }
+              },
+              "path": "v1/{+customer}/reports:countChromeDevicesReachingAutoExpirationDate",
+              "response": {
+                "$ref": "GoogleChromeManagementV1CountChromeDevicesReachingAutoExpirationDateResponse"
+              },
+              "scopes": [
+                "https://www.googleapis.com/auth/chrome.management.reports.readonly"
+              ]
+            },
+            "countChromeDevicesThatNeedAttention": {
+              "description": "Counts of ChromeOS devices that have not synced policies or have lacked user activity in the past 28 days, are out of date, or are not complaint. Further information can be found here https://support.google.com/chrome/a/answer/10564947",
+              "flatPath": "v1/customers/{customersId}/reports:countChromeDevicesThatNeedAttention",
+              "httpMethod": "GET",
+              "id": "chromemanagement.customers.reports.countChromeDevicesThatNeedAttention",
+              "parameterOrder": [
+                "customer"
+              ],
+              "parameters": {
+                "customer": {
+                  "description": "Required. The customer ID or \"my_customer\" prefixed with \"customers/\".",
+                  "location": "path",
+                  "pattern": "^customers/[^/]+$",
+                  "required": true,
+                  "type": "string"
+                },
+                "orgUnitId": {
+                  "description": "Optional. The ID of the organizational unit. If omitted, all data will be returned.",
+                  "location": "query",
+                  "type": "string"
+                },
+                "readMask": {
+                  "description": "Required. Mask of the fields that should be populated in the returned report.",
+                  "format": "google-fieldmask",
+                  "location": "query",
+                  "type": "string"
+                }
+              },
+              "path": "v1/{+customer}/reports:countChromeDevicesThatNeedAttention",
+              "response": {
+                "$ref": "GoogleChromeManagementV1CountChromeDevicesThatNeedAttentionResponse"
+              },
+              "scopes": [
+                "https://www.googleapis.com/auth/chrome.management.reports.readonly"
+              ]
+            },
             "countChromeVersions": {
               "description": "Generate report of installed Chrome versions.",
               "flatPath": "v1/customers/{customersId}/reports:countChromeVersions",
@@ -519,7 +595,7 @@
       }
     }
   },
-  "revision": "20220708",
+  "revision": "20220712",
   "rootUrl": "https://chromemanagement.googleapis.com/",
   "schemas": {
     "GoogleChromeManagementV1AndroidAppInfo": {
@@ -1087,6 +1163,52 @@
       },
       "type": "object"
     },
+    "GoogleChromeManagementV1CountChromeDevicesReachingAutoExpirationDateResponse": {
+      "description": "Response containing a list of devices expiring in each month of a selected time frame. Counts are grouped by model and Auto Update Expiration date.",
+      "id": "GoogleChromeManagementV1CountChromeDevicesReachingAutoExpirationDateResponse",
+      "properties": {
+        "deviceAueCountReports": {
+          "description": "The list of reports sorted by auto update expiration date in ascending order.",
+          "items": {
+            "$ref": "GoogleChromeManagementV1DeviceAueCountReport"
+          },
+          "type": "array"
+        }
+      },
+      "type": "object"
+    },
+    "GoogleChromeManagementV1CountChromeDevicesThatNeedAttentionResponse": {
+      "description": "Response containing counts for devices that need attention.",
+      "id": "GoogleChromeManagementV1CountChromeDevicesThatNeedAttentionResponse",
+      "properties": {
+        "noRecentPolicySyncCount": {
+          "description": "Number of ChromeOS devices have not synced policies in the past 28 days.",
+          "format": "int64",
+          "type": "string"
+        },
+        "noRecentUserActivityCount": {
+          "description": "Number of ChromeOS devices that have not seen any user activity in the past 28 days.",
+          "format": "int64",
+          "type": "string"
+        },
+        "osVersionNotCompliantCount": {
+          "description": "Number of devices whose OS version is not compliant.",
+          "format": "int64",
+          "type": "string"
+        },
+        "pendingUpdate": {
+          "description": "Number of devices that are pending an OS update.",
+          "format": "int64",
+          "type": "string"
+        },
+        "unsupportedPolicyCount": {
+          "description": "Number of devices that are unable to apply a policy due to an OS version mismatch.",
+          "format": "int64",
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
     "GoogleChromeManagementV1CountChromeVersionsResponse": {
       "description": "Response containing requested browser versions details and counts.",
       "id": "GoogleChromeManagementV1CountChromeVersionsResponse",
@@ -1242,6 +1364,65 @@
       },
       "type": "object"
     },
+    "GoogleChromeManagementV1DeviceAueCountReport": {
+      "description": "Report for CountChromeDevicesPerAueDateResponse, contains the count of devices of a specific model and auto update expiration range.",
+      "id": "GoogleChromeManagementV1DeviceAueCountReport",
+      "properties": {
+        "aueMonth": {
+          "description": "Enum value of month corresponding to the auto update expiration date in UTC time zone. If the device is already expired, this field is empty.",
+          "enum": [
+            "MONTH_UNSPECIFIED",
+            "JANUARY",
+            "FEBRUARY",
+            "MARCH",
+            "APRIL",
+            "MAY",
+            "JUNE",
+            "JULY",
+            "AUGUST",
+            "SEPTEMBER",
+            "OCTOBER",
+            "NOVEMBER",
+            "DECEMBER"
+          ],
+          "enumDescriptions": [
+            "The unspecified month.",
+            "The month of January.",
+            "The month of February.",
+            "The month of March.",
+            "The month of April.",
+            "The month of May.",
+            "The month of June.",
+            "The month of July.",
+            "The month of August.",
+            "The month of September.",
+            "The month of October.",
+            "The month of November.",
+            "The month of December."
+          ],
+          "type": "string"
+        },
+        "aueYear": {
+          "description": "Int value of year corresponding to the Auto Update Expiration date in UTC time zone. If the device is already expired, this field is empty.",
+          "format": "int64",
+          "type": "string"
+        },
+        "count": {
+          "description": "Count of devices of this model.",
+          "format": "int64",
+          "type": "string"
+        },
+        "expired": {
+          "description": "Boolean value for whether or not the device has already expired.",
+          "type": "boolean"
+        },
+        "model": {
+          "description": "Public model name of the devices.",
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
     "GoogleChromeManagementV1DiskInfo": {
       "description": "Status of the single storage device.",
       "id": "GoogleChromeManagementV1DiskInfo",

From df983ba85172cc3f0ee1a99155c449e15b224285 Mon Sep 17 00:00:00 2001
From: Yoshi Automation 
Date: Tue, 19 Jul 2022 07:08:10 +0000
Subject: [PATCH 05/23] feat(chromepolicy): update the api

#### chromepolicy:v1

The following keys were added:
- resources.media.methods.upload (Total Keys: 16)
- schemas.GoogleChromePolicyV1UploadPolicyFileRequest (Total Keys: 3)
- schemas.GoogleChromePolicyV1UploadPolicyFileResponse (Total Keys: 3)
---
 docs/dyn/chromepolicy_v1.html                 |  5 ++
 .../documents/chromepolicy.v1.json            | 68 ++++++++++++++++++-
 2 files changed, 72 insertions(+), 1 deletion(-)

diff --git a/docs/dyn/chromepolicy_v1.html b/docs/dyn/chromepolicy_v1.html
index 5f10b74a5c3..f589f50aae3 100644
--- a/docs/dyn/chromepolicy_v1.html
+++ b/docs/dyn/chromepolicy_v1.html
@@ -79,6 +79,11 @@ 

Instance Methods

Returns the customers Resource.

+

+ media() +

+

Returns the media Resource.

+

close()

Close httplib2 connections.

diff --git a/googleapiclient/discovery_cache/documents/chromepolicy.v1.json b/googleapiclient/discovery_cache/documents/chromepolicy.v1.json index 6bbe186b137..2e0c906295d 100644 --- a/googleapiclient/discovery_cache/documents/chromepolicy.v1.json +++ b/googleapiclient/discovery_cache/documents/chromepolicy.v1.json @@ -278,9 +278,53 @@ } } } + }, + "media": { + "methods": { + "upload": { + "description": "Creates an enterprise file from the content provided by user. Returns a public download url for end user.", + "flatPath": "v1/customers/{customersId}/policies/files:uploadPolicyFile", + "httpMethod": "POST", + "id": "chromepolicy.media.upload", + "mediaUpload": { + "accept": [ + "*/*" + ], + "protocols": { + "simple": { + "multipart": true, + "path": "/upload/v1/{+customer}/policies/files:uploadPolicyFile" + } + } + }, + "parameterOrder": [ + "customer" + ], + "parameters": { + "customer": { + "description": "Required. The customer for which the file upload will apply.", + "location": "path", + "pattern": "^customers/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+customer}/policies/files:uploadPolicyFile", + "request": { + "$ref": "GoogleChromePolicyV1UploadPolicyFileRequest" + }, + "response": { + "$ref": "GoogleChromePolicyV1UploadPolicyFileResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/chrome.management.policy" + ], + "supportsMediaUpload": true + } + } } }, - "revision": "20220708", + "revision": "20220718", "rootUrl": "https://chromepolicy.googleapis.com/", "schemas": { "ChromeCrosDpanelAutosettingsProtoPolicyApiLifecycle": { @@ -736,6 +780,28 @@ }, "type": "object" }, + "GoogleChromePolicyV1UploadPolicyFileRequest": { + "description": "Request message for uploading a file for a policy. Next ID: 5", + "id": "GoogleChromePolicyV1UploadPolicyFileRequest", + "properties": { + "policyField": { + "description": "Required. The fully qualified policy schema and field name this file is uploaded for. This information will be used to validate the content type of the file.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleChromePolicyV1UploadPolicyFileResponse": { + "description": "Response message for downloading an uploaded file. Next ID: 2", + "id": "GoogleChromePolicyV1UploadPolicyFileResponse", + "properties": { + "downloadUri": { + "description": "The uri for end user to download the file.", + "type": "string" + } + }, + "type": "object" + }, "GoogleProtobufEmpty": { "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", "id": "GoogleProtobufEmpty", From f6b2cad08f7c87a5001023c85281e0c80a1e57ee Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 19 Jul 2022 07:08:10 +0000 Subject: [PATCH 06/23] feat(cloudfunctions): update the api #### cloudfunctions:v1 The following keys were added: - schemas.GoogleCloudFunctionsV2OperationMetadata (Total Keys: 15) - schemas.GoogleCloudFunctionsV2Stage (Total Keys: 9) - schemas.GoogleCloudFunctionsV2StateMessage (Total Keys: 5) #### cloudfunctions:v2 The following keys were added: - resources.projects.resources.locations.resources.functions.methods.create (Total Keys: 14) - resources.projects.resources.locations.resources.functions.methods.delete (Total Keys: 11) - resources.projects.resources.locations.resources.functions.methods.get (Total Keys: 11) - resources.projects.resources.locations.resources.functions.methods.list (Total Keys: 20) - resources.projects.resources.locations.resources.functions.methods.patch (Total Keys: 15) - resources.projects.resources.locations.resources.runtimes.methods.list (Total Keys: 13) - schemas.BuildConfig (Total Keys: 13) - schemas.EventFilter (Total Keys: 5) - schemas.EventTrigger (Total Keys: 12) - schemas.Function (Total Keys: 17) - schemas.GoogleCloudFunctionsV2OperationMetadata (Total Keys: 15) - schemas.GoogleCloudFunctionsV2Stage (Total Keys: 9) - schemas.GoogleCloudFunctionsV2StateMessage (Total Keys: 5) - schemas.ListFunctionsResponse (Total Keys: 7) - schemas.ListRuntimesResponse (Total Keys: 4) - schemas.RepoSource (Total Keys: 9) - schemas.Runtime (Total Keys: 8) - schemas.SecretEnvVar (Total Keys: 6) - schemas.SecretVersion (Total Keys: 4) - schemas.SecretVolume (Total Keys: 7) - schemas.ServiceConfig (Total Keys: 23) - schemas.Source (Total Keys: 8) - schemas.StorageSource (Total Keys: 6) #### cloudfunctions:v2alpha The following keys were added: - schemas.GoogleCloudFunctionsV2OperationMetadata (Total Keys: 15) - schemas.GoogleCloudFunctionsV2Stage (Total Keys: 9) - schemas.GoogleCloudFunctionsV2StateMessage (Total Keys: 5) #### cloudfunctions:v2beta The following keys were added: - schemas.GoogleCloudFunctionsV2OperationMetadata (Total Keys: 15) - schemas.GoogleCloudFunctionsV2Stage (Total Keys: 9) - schemas.GoogleCloudFunctionsV2StateMessage (Total Keys: 5) --- ...tions_v2.projects.locations.functions.html | 704 +++++++++++ .../cloudfunctions_v2.projects.locations.html | 5 + ...ctions_v2.projects.locations.runtimes.html | 119 ++ .../documents/cloudfunctions.v1.json | 149 ++- .../documents/cloudfunctions.v2.json | 1071 ++++++++++++++++- .../documents/cloudfunctions.v2alpha.json | 149 ++- .../documents/cloudfunctions.v2beta.json | 149 ++- 7 files changed, 2301 insertions(+), 45 deletions(-) create mode 100644 docs/dyn/cloudfunctions_v2.projects.locations.runtimes.html diff --git a/docs/dyn/cloudfunctions_v2.projects.locations.functions.html b/docs/dyn/cloudfunctions_v2.projects.locations.functions.html index 7acf690e87f..0125910ab7e 100644 --- a/docs/dyn/cloudfunctions_v2.projects.locations.functions.html +++ b/docs/dyn/cloudfunctions_v2.projects.locations.functions.html @@ -77,9 +77,33 @@

Instance Methods

close()

Close httplib2 connections.

+

+ create(parent, body=None, functionId=None, x__xgafv=None)

+

Creates a new function. If a function with the given name already exists in the specified project, the long running operation will return `ALREADY_EXISTS` error.

+

+ delete(name, x__xgafv=None)

+

Deletes a function with the given name from the specified project. If the given function is used by some trigger, the trigger will be updated to remove this function.

+

+ generateDownloadUrl(name, body=None, x__xgafv=None)

+

Returns a signed URL for downloading deployed function source code. The URL is only valid for a limited period and should be used within 30 minutes of generation. For more information about the signed URL usage see: https://cloud.google.com/storage/docs/access-control/signed-urls

+

+ generateUploadUrl(parent, body=None, x__xgafv=None)

+

Returns a signed URL for uploading a function source code. For more information about the signed URL usage see: https://cloud.google.com/storage/docs/access-control/signed-urls. Once the function source code upload is complete, the used signed URL should be provided in CreateFunction or UpdateFunction request as a reference to the function source code. When uploading source code to the generated signed URL, please follow these restrictions: * Source file type should be a zip file. * No credentials should be attached - the signed URLs provide access to the target bucket using internal service identity; if credentials were attached, the identity from the credentials would be used, but that identity does not have permissions to upload files to the URL. When making a HTTP PUT request, these two headers need to be specified: * `content-type: application/zip` And this header SHOULD NOT be specified: * `Authorization: Bearer YOUR_TOKEN`

+

+ get(name, x__xgafv=None)

+

Returns a function with the given name from the requested project.

getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

+

+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

+

Returns a list of functions that belong to the requested project.

+

+ list_next()

+

Retrieves the next page of results.

+

+ patch(name, body=None, updateMask=None, x__xgafv=None)

+

Updates existing function.

setIamPolicy(resource, body=None, x__xgafv=None)

Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.

@@ -92,6 +116,378 @@

Method Details

Close httplib2 connections.
+
+ create(parent, body=None, functionId=None, x__xgafv=None) +
Creates a new function. If a function with the given name already exists in the specified project, the long running operation will return `ALREADY_EXISTS` error.
+
+Args:
+  parent: string, Required. The project and location in which the function should be created, specified in the format `projects/*/locations/*` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Describes a Cloud Function that contains user computation executed in response to an event. It encapsulates function and trigger configurations.
+  "buildConfig": { # Describes the Build step of the function that builds a container from the given source. # Describes the Build step of the function that builds a container from the given source.
+    "build": "A String", # Output only. The Cloud Build name of the latest successful deployment of the function.
+    "dockerRepository": "A String", # Optional. User managed repository created in Artifact Registry optionally with a customer managed encryption key. This is the repository to which the function docker image will be pushed after it is built by Cloud Build. If unspecified, GCF will create and use a repository named 'gcf-artifacts' for every deployed region. It must match the pattern `projects/{project}/locations/{location}/repositories/{repository}`. Cross-project repositories are not supported. Cross-location repositories are not supported. Repository format must be 'DOCKER'.
+    "entryPoint": "A String", # The name of the function (as defined in source code) that will be executed. Defaults to the resource name suffix, if not specified. For backward compatibility, if function with given name is not found, then the system will try to use function named "function". For Node.js this is name of a function exported by the module specified in `source_location`.
+    "environmentVariables": { # User-provided build-time environment variables for the function
+      "a_key": "A String",
+    },
+    "runtime": "A String", # The runtime in which to run the function. Required when deploying a new function, optional when updating an existing function. For a complete list of possible choices, see the [`gcloud` command reference](https://cloud.google.com/sdk/gcloud/reference/functions/deploy#--runtime).
+    "source": { # The location of the function source code. # The location of the function source code.
+      "repoSource": { # Location of the source in a Google Cloud Source Repository. # If provided, get the source from this location in a Cloud Source Repository.
+        "branchName": "A String", # Regex matching branches to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax
+        "commitSha": "A String", # Explicit commit SHA to build.
+        "dir": "A String", # Directory, relative to the source root, in which to run the build. This must be a relative path. If a step's `dir` is specified and is an absolute path, this value is ignored for that step's execution. eg. helloworld (no leading slash allowed)
+        "invertRegex": True or False, # Only trigger a build if the revision regex does NOT match the revision regex.
+        "projectId": "A String", # ID of the project that owns the Cloud Source Repository. If omitted, the project ID requesting the build is assumed.
+        "repoName": "A String", # Name of the Cloud Source Repository.
+        "tagName": "A String", # Regex matching tags to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax
+      },
+      "storageSource": { # Location of the source in an archive file in Google Cloud Storage. # If provided, get the source from this location in Google Cloud Storage.
+        "bucket": "A String", # Google Cloud Storage bucket containing the source (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
+        "generation": "A String", # Google Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used.
+        "object": "A String", # Google Cloud Storage object containing the source. This object must be a gzipped archive file (`.tar.gz`) containing source to build.
+      },
+    },
+    "sourceProvenance": { # Provenance of the source. Ways to find the original source, or verify that some source was used for this build. # Output only. A permanent fixed identifier for source.
+      "resolvedRepoSource": { # Location of the source in a Google Cloud Source Repository. # A copy of the build's `source.repo_source`, if exists, with any revisions resolved.
+        "branchName": "A String", # Regex matching branches to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax
+        "commitSha": "A String", # Explicit commit SHA to build.
+        "dir": "A String", # Directory, relative to the source root, in which to run the build. This must be a relative path. If a step's `dir` is specified and is an absolute path, this value is ignored for that step's execution. eg. helloworld (no leading slash allowed)
+        "invertRegex": True or False, # Only trigger a build if the revision regex does NOT match the revision regex.
+        "projectId": "A String", # ID of the project that owns the Cloud Source Repository. If omitted, the project ID requesting the build is assumed.
+        "repoName": "A String", # Name of the Cloud Source Repository.
+        "tagName": "A String", # Regex matching tags to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax
+      },
+      "resolvedStorageSource": { # Location of the source in an archive file in Google Cloud Storage. # A copy of the build's `source.storage_source`, if exists, with any generations resolved.
+        "bucket": "A String", # Google Cloud Storage bucket containing the source (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
+        "generation": "A String", # Google Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used.
+        "object": "A String", # Google Cloud Storage object containing the source. This object must be a gzipped archive file (`.tar.gz`) containing source to build.
+      },
+    },
+    "workerPool": "A String", # Name of the Cloud Build Custom Worker Pool that should be used to build the function. The format of this field is `projects/{project}/locations/{region}/workerPools/{workerPool}` where {project} and {region} are the project id and region respectively where the worker pool is defined and {workerPool} is the short name of the worker pool. If the project id is not the same as the function, then the Cloud Functions Service Agent (service-@gcf-admin-robot.iam.gserviceaccount.com) must be granted the role Cloud Build Custom Workers Builder (roles/cloudbuild.customworkers.builder) in the project.
+  },
+  "description": "A String", # User-provided description of a function.
+  "environment": "A String", # Describe whether the function is gen1 or gen2.
+  "eventTrigger": { # Describes EventTrigger, used to request events to be sent from another service. # An Eventarc trigger managed by Google Cloud Functions that fires events in response to a condition in another service.
+    "channel": "A String", # Optional. The name of the channel associated with the trigger in `projects/{project}/locations/{location}/channels/{channel}` format. You must provide a channel to receive events from Eventarc SaaS partners.
+    "eventFilters": [ # Criteria used to filter events.
+      { # Filters events based on exact matches on the CloudEvents attributes.
+        "attribute": "A String", # Required. The name of a CloudEvents attribute.
+        "operator": "A String", # Optional. The operator used for matching the events with the value of the filter. If not specified, only events that have an exact key-value pair specified in the filter are matched. The only allowed value is `match-path-pattern`.
+        "value": "A String", # Required. The value for the attribute.
+      },
+    ],
+    "eventType": "A String", # Required. The type of event to observe. For example: `google.cloud.audit.log.v1.written` or `google.cloud.pubsub.topic.v1.messagePublished`.
+    "pubsubTopic": "A String", # Optional. The name of a Pub/Sub topic in the same project that will be used as the transport topic for the event delivery. Format: `projects/{project}/topics/{topic}`. This is only valid for events of type `google.cloud.pubsub.topic.v1.messagePublished`. The topic provided here will not be deleted at function deletion.
+    "retryPolicy": "A String", # Optional. If unset, then defaults to ignoring failures (i.e. not retrying them).
+    "serviceAccountEmail": "A String", # Optional. The email of the trigger's service account. The service account must have permission to invoke Cloud Run services, the permission is `run.routes.invoke`. If empty, defaults to the Compute Engine default service account: `{project_number}-compute@developer.gserviceaccount.com`.
+    "trigger": "A String", # Output only. The resource name of the Eventarc trigger. The format of this field is `projects/{project}/locations/{region}/triggers/{trigger}`.
+    "triggerRegion": "A String", # The region that the trigger will be in. The trigger will only receive events originating in this region. It can be the same region as the function, a different region or multi-region, or the global region. If not provided, defaults to the same region as the function.
+  },
+  "labels": { # Labels associated with this Cloud Function.
+    "a_key": "A String",
+  },
+  "name": "A String", # A user-defined name of the function. Function names must be unique globally and match pattern `projects/*/locations/*/functions/*`
+  "serviceConfig": { # Describes the Service being deployed. Currently Supported : Cloud Run (fully managed). # Describes the Service being deployed. Currently deploys services to Cloud Run (fully managed).
+    "allTrafficOnLatestRevision": True or False, # Whether 100% of traffic is routed to the latest revision. On CreateFunction and UpdateFunction, when set to true, the revision being deployed will serve 100% of traffic, ignoring any traffic split settings, if any. On GetFunction, true will be returned if the latest revision is serving 100% of traffic.
+    "availableMemory": "A String", # The amount of memory available for a function. Defaults to 256M. Supported units are k, M, G, Mi, Gi. If no unit is supplied the value is interpreted as bytes. See https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/quantity.go a full description.
+    "environmentVariables": { # Environment variables that shall be available during function execution.
+      "a_key": "A String",
+    },
+    "ingressSettings": "A String", # The ingress settings for the function, controlling what traffic can reach it.
+    "maxInstanceCount": 42, # The limit on the maximum number of function instances that may coexist at a given time. In some cases, such as rapid traffic surges, Cloud Functions may, for a short period of time, create more instances than the specified max instances limit. If your function cannot tolerate this temporary behavior, you may want to factor in a safety margin and set a lower max instances value than your function can tolerate. See the [Max Instances](https://cloud.google.com/functions/docs/max-instances) Guide for more details.
+    "minInstanceCount": 42, # The limit on the minimum number of function instances that may coexist at a given time. Function instances are kept in idle state for a short period after they finished executing the request to reduce cold start time for subsequent requests. Setting a minimum instance count will ensure that the given number of instances are kept running in idle state always. This can help with cold start times when jump in incoming request count occurs after the idle instance would have been stopped in the default case.
+    "revision": "A String", # Output only. The name of service revision.
+    "secretEnvironmentVariables": [ # Secret environment variables configuration.
+      { # Configuration for a secret environment variable. It has the information necessary to fetch the secret value from secret manager and expose it as an environment variable.
+        "key": "A String", # Name of the environment variable.
+        "projectId": "A String", # Project identifier (preferably project number but can also be the project ID) of the project that contains the secret. If not set, it is assumed that the secret is in the same project as the function.
+        "secret": "A String", # Name of the secret in secret manager (not the full resource name).
+        "version": "A String", # Version of the secret (version number or the string 'latest'). It is recommended to use a numeric version for secret environment variables as any updates to the secret value is not reflected until new instances start.
+      },
+    ],
+    "secretVolumes": [ # Secret volumes configuration.
+      { # Configuration for a secret volume. It has the information necessary to fetch the secret value from secret manager and make it available as files mounted at the requested paths within the application container.
+        "mountPath": "A String", # The path within the container to mount the secret volume. For example, setting the mount_path as `/etc/secrets` would mount the secret value files under the `/etc/secrets` directory. This directory will also be completely shadowed and unavailable to mount any other secrets. Recommended mount path: /etc/secrets
+        "projectId": "A String", # Project identifier (preferably project number but can also be the project ID) of the project that contains the secret. If not set, it is assumed that the secret is in the same project as the function.
+        "secret": "A String", # Name of the secret in secret manager (not the full resource name).
+        "versions": [ # List of secret versions to mount for this secret. If empty, the `latest` version of the secret will be made available in a file named after the secret under the mount point.
+          { # Configuration for a single version.
+            "path": "A String", # Relative path of the file under the mount path where the secret value for this version will be fetched and made available. For example, setting the mount_path as '/etc/secrets' and path as `secret_foo` would mount the secret value file at `/etc/secrets/secret_foo`.
+            "version": "A String", # Version of the secret (version number or the string 'latest'). It is preferable to use `latest` version with secret volumes as secret value changes are reflected immediately.
+          },
+        ],
+      },
+    ],
+    "service": "A String", # Output only. Name of the service associated with a Function. The format of this field is `projects/{project}/locations/{region}/services/{service}`
+    "serviceAccountEmail": "A String", # The email of the service's service account. If empty, defaults to `{project_number}-compute@developer.gserviceaccount.com`.
+    "timeoutSeconds": 42, # The function execution timeout. Execution is considered failed and can be terminated if the function is not completed at the end of the timeout period. Defaults to 60 seconds.
+    "uri": "A String", # Output only. URI of the Service deployed.
+    "vpcConnector": "A String", # The Serverless VPC Access connector that this cloud function can connect to. The format of this field is `projects/*/locations/*/connectors/*`.
+    "vpcConnectorEgressSettings": "A String", # The egress settings for the connector, controlling what traffic is diverted through it.
+  },
+  "state": "A String", # Output only. State of the function.
+  "stateMessages": [ # Output only. State Messages for this Cloud Function.
+    { # Informational messages about the state of the Cloud Function or Operation.
+      "message": "A String", # The message.
+      "severity": "A String", # Severity of the state message.
+      "type": "A String", # One-word CamelCase type of the state message.
+    },
+  ],
+  "updateTime": "A String", # Output only. The last update timestamp of a Cloud Function.
+}
+
+  functionId: string, The ID to use for the function, which will become the final component of the function's resource name. This value should be 4-63 characters, and valid characters are /a-z-/.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # 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.
+  "error": { # 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). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # 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.
+  },
+  "metadata": { # 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.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # 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}`.
+  "response": { # 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`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ delete(name, x__xgafv=None) +
Deletes a function with the given name from the specified project. If the given function is used by some trigger, the trigger will be updated to remove this function.
+
+Args:
+  name: string, Required. The name of the function which should be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # 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.
+  "error": { # 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). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # 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.
+  },
+  "metadata": { # 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.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # 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}`.
+  "response": { # 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`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ generateDownloadUrl(name, body=None, x__xgafv=None) +
Returns a signed URL for downloading deployed function source code. The URL is only valid for a limited period and should be used within 30 minutes of generation. For more information about the signed URL usage see: https://cloud.google.com/storage/docs/access-control/signed-urls
+
+Args:
+  name: string, Required. The name of function for which source code Google Cloud Storage signed URL should be generated. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request of `GenerateDownloadUrl` method.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response of `GenerateDownloadUrl` method.
+  "downloadUrl": "A String", # The generated Google Cloud Storage signed URL that should be used for function source code download.
+}
+
+ +
+ generateUploadUrl(parent, body=None, x__xgafv=None) +
Returns a signed URL for uploading a function source code. For more information about the signed URL usage see: https://cloud.google.com/storage/docs/access-control/signed-urls. Once the function source code upload is complete, the used signed URL should be provided in CreateFunction or UpdateFunction request as a reference to the function source code. When uploading source code to the generated signed URL, please follow these restrictions: * Source file type should be a zip file. * No credentials should be attached - the signed URLs provide access to the target bucket using internal service identity; if credentials were attached, the identity from the credentials would be used, but that identity does not have permissions to upload files to the URL. When making a HTTP PUT request, these two headers need to be specified: * `content-type: application/zip` And this header SHOULD NOT be specified: * `Authorization: Bearer YOUR_TOKEN`
+
+Args:
+  parent: string, Required. The project and location in which the Google Cloud Storage signed URL should be generated, specified in the format `projects/*/locations/*`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request of `GenerateSourceUploadUrl` method.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response of `GenerateSourceUploadUrl` method.
+  "storageSource": { # Location of the source in an archive file in Google Cloud Storage. # The location of the source code in the upload bucket. Once the archive is uploaded using the `upload_url` use this field to set the `function.build_config.source.storage_source` during CreateFunction and UpdateFunction. Generation defaults to 0, as Cloud Storage provides a new generation only upon uploading a new object or version of an object.
+    "bucket": "A String", # Google Cloud Storage bucket containing the source (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
+    "generation": "A String", # Google Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used.
+    "object": "A String", # Google Cloud Storage object containing the source. This object must be a gzipped archive file (`.tar.gz`) containing source to build.
+  },
+  "uploadUrl": "A String", # The generated Google Cloud Storage signed URL that should be used for a function source code upload. The uploaded file should be a zip archive which contains a function.
+}
+
+ +
+ get(name, x__xgafv=None) +
Returns a function with the given name from the requested project.
+
+Args:
+  name: string, Required. The name of the function which details should be obtained. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Describes a Cloud Function that contains user computation executed in response to an event. It encapsulates function and trigger configurations.
+  "buildConfig": { # Describes the Build step of the function that builds a container from the given source. # Describes the Build step of the function that builds a container from the given source.
+    "build": "A String", # Output only. The Cloud Build name of the latest successful deployment of the function.
+    "dockerRepository": "A String", # Optional. User managed repository created in Artifact Registry optionally with a customer managed encryption key. This is the repository to which the function docker image will be pushed after it is built by Cloud Build. If unspecified, GCF will create and use a repository named 'gcf-artifacts' for every deployed region. It must match the pattern `projects/{project}/locations/{location}/repositories/{repository}`. Cross-project repositories are not supported. Cross-location repositories are not supported. Repository format must be 'DOCKER'.
+    "entryPoint": "A String", # The name of the function (as defined in source code) that will be executed. Defaults to the resource name suffix, if not specified. For backward compatibility, if function with given name is not found, then the system will try to use function named "function". For Node.js this is name of a function exported by the module specified in `source_location`.
+    "environmentVariables": { # User-provided build-time environment variables for the function
+      "a_key": "A String",
+    },
+    "runtime": "A String", # The runtime in which to run the function. Required when deploying a new function, optional when updating an existing function. For a complete list of possible choices, see the [`gcloud` command reference](https://cloud.google.com/sdk/gcloud/reference/functions/deploy#--runtime).
+    "source": { # The location of the function source code. # The location of the function source code.
+      "repoSource": { # Location of the source in a Google Cloud Source Repository. # If provided, get the source from this location in a Cloud Source Repository.
+        "branchName": "A String", # Regex matching branches to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax
+        "commitSha": "A String", # Explicit commit SHA to build.
+        "dir": "A String", # Directory, relative to the source root, in which to run the build. This must be a relative path. If a step's `dir` is specified and is an absolute path, this value is ignored for that step's execution. eg. helloworld (no leading slash allowed)
+        "invertRegex": True or False, # Only trigger a build if the revision regex does NOT match the revision regex.
+        "projectId": "A String", # ID of the project that owns the Cloud Source Repository. If omitted, the project ID requesting the build is assumed.
+        "repoName": "A String", # Name of the Cloud Source Repository.
+        "tagName": "A String", # Regex matching tags to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax
+      },
+      "storageSource": { # Location of the source in an archive file in Google Cloud Storage. # If provided, get the source from this location in Google Cloud Storage.
+        "bucket": "A String", # Google Cloud Storage bucket containing the source (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
+        "generation": "A String", # Google Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used.
+        "object": "A String", # Google Cloud Storage object containing the source. This object must be a gzipped archive file (`.tar.gz`) containing source to build.
+      },
+    },
+    "sourceProvenance": { # Provenance of the source. Ways to find the original source, or verify that some source was used for this build. # Output only. A permanent fixed identifier for source.
+      "resolvedRepoSource": { # Location of the source in a Google Cloud Source Repository. # A copy of the build's `source.repo_source`, if exists, with any revisions resolved.
+        "branchName": "A String", # Regex matching branches to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax
+        "commitSha": "A String", # Explicit commit SHA to build.
+        "dir": "A String", # Directory, relative to the source root, in which to run the build. This must be a relative path. If a step's `dir` is specified and is an absolute path, this value is ignored for that step's execution. eg. helloworld (no leading slash allowed)
+        "invertRegex": True or False, # Only trigger a build if the revision regex does NOT match the revision regex.
+        "projectId": "A String", # ID of the project that owns the Cloud Source Repository. If omitted, the project ID requesting the build is assumed.
+        "repoName": "A String", # Name of the Cloud Source Repository.
+        "tagName": "A String", # Regex matching tags to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax
+      },
+      "resolvedStorageSource": { # Location of the source in an archive file in Google Cloud Storage. # A copy of the build's `source.storage_source`, if exists, with any generations resolved.
+        "bucket": "A String", # Google Cloud Storage bucket containing the source (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
+        "generation": "A String", # Google Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used.
+        "object": "A String", # Google Cloud Storage object containing the source. This object must be a gzipped archive file (`.tar.gz`) containing source to build.
+      },
+    },
+    "workerPool": "A String", # Name of the Cloud Build Custom Worker Pool that should be used to build the function. The format of this field is `projects/{project}/locations/{region}/workerPools/{workerPool}` where {project} and {region} are the project id and region respectively where the worker pool is defined and {workerPool} is the short name of the worker pool. If the project id is not the same as the function, then the Cloud Functions Service Agent (service-@gcf-admin-robot.iam.gserviceaccount.com) must be granted the role Cloud Build Custom Workers Builder (roles/cloudbuild.customworkers.builder) in the project.
+  },
+  "description": "A String", # User-provided description of a function.
+  "environment": "A String", # Describe whether the function is gen1 or gen2.
+  "eventTrigger": { # Describes EventTrigger, used to request events to be sent from another service. # An Eventarc trigger managed by Google Cloud Functions that fires events in response to a condition in another service.
+    "channel": "A String", # Optional. The name of the channel associated with the trigger in `projects/{project}/locations/{location}/channels/{channel}` format. You must provide a channel to receive events from Eventarc SaaS partners.
+    "eventFilters": [ # Criteria used to filter events.
+      { # Filters events based on exact matches on the CloudEvents attributes.
+        "attribute": "A String", # Required. The name of a CloudEvents attribute.
+        "operator": "A String", # Optional. The operator used for matching the events with the value of the filter. If not specified, only events that have an exact key-value pair specified in the filter are matched. The only allowed value is `match-path-pattern`.
+        "value": "A String", # Required. The value for the attribute.
+      },
+    ],
+    "eventType": "A String", # Required. The type of event to observe. For example: `google.cloud.audit.log.v1.written` or `google.cloud.pubsub.topic.v1.messagePublished`.
+    "pubsubTopic": "A String", # Optional. The name of a Pub/Sub topic in the same project that will be used as the transport topic for the event delivery. Format: `projects/{project}/topics/{topic}`. This is only valid for events of type `google.cloud.pubsub.topic.v1.messagePublished`. The topic provided here will not be deleted at function deletion.
+    "retryPolicy": "A String", # Optional. If unset, then defaults to ignoring failures (i.e. not retrying them).
+    "serviceAccountEmail": "A String", # Optional. The email of the trigger's service account. The service account must have permission to invoke Cloud Run services, the permission is `run.routes.invoke`. If empty, defaults to the Compute Engine default service account: `{project_number}-compute@developer.gserviceaccount.com`.
+    "trigger": "A String", # Output only. The resource name of the Eventarc trigger. The format of this field is `projects/{project}/locations/{region}/triggers/{trigger}`.
+    "triggerRegion": "A String", # The region that the trigger will be in. The trigger will only receive events originating in this region. It can be the same region as the function, a different region or multi-region, or the global region. If not provided, defaults to the same region as the function.
+  },
+  "labels": { # Labels associated with this Cloud Function.
+    "a_key": "A String",
+  },
+  "name": "A String", # A user-defined name of the function. Function names must be unique globally and match pattern `projects/*/locations/*/functions/*`
+  "serviceConfig": { # Describes the Service being deployed. Currently Supported : Cloud Run (fully managed). # Describes the Service being deployed. Currently deploys services to Cloud Run (fully managed).
+    "allTrafficOnLatestRevision": True or False, # Whether 100% of traffic is routed to the latest revision. On CreateFunction and UpdateFunction, when set to true, the revision being deployed will serve 100% of traffic, ignoring any traffic split settings, if any. On GetFunction, true will be returned if the latest revision is serving 100% of traffic.
+    "availableMemory": "A String", # The amount of memory available for a function. Defaults to 256M. Supported units are k, M, G, Mi, Gi. If no unit is supplied the value is interpreted as bytes. See https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/quantity.go a full description.
+    "environmentVariables": { # Environment variables that shall be available during function execution.
+      "a_key": "A String",
+    },
+    "ingressSettings": "A String", # The ingress settings for the function, controlling what traffic can reach it.
+    "maxInstanceCount": 42, # The limit on the maximum number of function instances that may coexist at a given time. In some cases, such as rapid traffic surges, Cloud Functions may, for a short period of time, create more instances than the specified max instances limit. If your function cannot tolerate this temporary behavior, you may want to factor in a safety margin and set a lower max instances value than your function can tolerate. See the [Max Instances](https://cloud.google.com/functions/docs/max-instances) Guide for more details.
+    "minInstanceCount": 42, # The limit on the minimum number of function instances that may coexist at a given time. Function instances are kept in idle state for a short period after they finished executing the request to reduce cold start time for subsequent requests. Setting a minimum instance count will ensure that the given number of instances are kept running in idle state always. This can help with cold start times when jump in incoming request count occurs after the idle instance would have been stopped in the default case.
+    "revision": "A String", # Output only. The name of service revision.
+    "secretEnvironmentVariables": [ # Secret environment variables configuration.
+      { # Configuration for a secret environment variable. It has the information necessary to fetch the secret value from secret manager and expose it as an environment variable.
+        "key": "A String", # Name of the environment variable.
+        "projectId": "A String", # Project identifier (preferably project number but can also be the project ID) of the project that contains the secret. If not set, it is assumed that the secret is in the same project as the function.
+        "secret": "A String", # Name of the secret in secret manager (not the full resource name).
+        "version": "A String", # Version of the secret (version number or the string 'latest'). It is recommended to use a numeric version for secret environment variables as any updates to the secret value is not reflected until new instances start.
+      },
+    ],
+    "secretVolumes": [ # Secret volumes configuration.
+      { # Configuration for a secret volume. It has the information necessary to fetch the secret value from secret manager and make it available as files mounted at the requested paths within the application container.
+        "mountPath": "A String", # The path within the container to mount the secret volume. For example, setting the mount_path as `/etc/secrets` would mount the secret value files under the `/etc/secrets` directory. This directory will also be completely shadowed and unavailable to mount any other secrets. Recommended mount path: /etc/secrets
+        "projectId": "A String", # Project identifier (preferably project number but can also be the project ID) of the project that contains the secret. If not set, it is assumed that the secret is in the same project as the function.
+        "secret": "A String", # Name of the secret in secret manager (not the full resource name).
+        "versions": [ # List of secret versions to mount for this secret. If empty, the `latest` version of the secret will be made available in a file named after the secret under the mount point.
+          { # Configuration for a single version.
+            "path": "A String", # Relative path of the file under the mount path where the secret value for this version will be fetched and made available. For example, setting the mount_path as '/etc/secrets' and path as `secret_foo` would mount the secret value file at `/etc/secrets/secret_foo`.
+            "version": "A String", # Version of the secret (version number or the string 'latest'). It is preferable to use `latest` version with secret volumes as secret value changes are reflected immediately.
+          },
+        ],
+      },
+    ],
+    "service": "A String", # Output only. Name of the service associated with a Function. The format of this field is `projects/{project}/locations/{region}/services/{service}`
+    "serviceAccountEmail": "A String", # The email of the service's service account. If empty, defaults to `{project_number}-compute@developer.gserviceaccount.com`.
+    "timeoutSeconds": 42, # The function execution timeout. Execution is considered failed and can be terminated if the function is not completed at the end of the timeout period. Defaults to 60 seconds.
+    "uri": "A String", # Output only. URI of the Service deployed.
+    "vpcConnector": "A String", # The Serverless VPC Access connector that this cloud function can connect to. The format of this field is `projects/*/locations/*/connectors/*`.
+    "vpcConnectorEgressSettings": "A String", # The egress settings for the connector, controlling what traffic is diverted through it.
+  },
+  "state": "A String", # Output only. State of the function.
+  "stateMessages": [ # Output only. State Messages for this Cloud Function.
+    { # Informational messages about the state of the Cloud Function or Operation.
+      "message": "A String", # The message.
+      "severity": "A String", # Severity of the state message.
+      "type": "A String", # One-word CamelCase type of the state message.
+    },
+  ],
+  "updateTime": "A String", # Output only. The last update timestamp of a Cloud Function.
+}
+
+
getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
@@ -140,6 +536,314 @@ 

Method Details

}
+
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Returns a list of functions that belong to the requested project.
+
+Args:
+  parent: string, Required. The project and location from which the function should be listed, specified in the format `projects/*/locations/*` If you want to list functions in all locations, use "-" in place of a location. When listing functions in all locations, if one or more location(s) are unreachable, the response will contain functions from all reachable locations along with the names of any unreachable locations. (required)
+  filter: string, The filter for Functions that match the filter expression, following the syntax outlined in https://google.aip.dev/160.
+  orderBy: string, The sorting order of the resources returned. Value should be a comma separated list of fields. The default sorting oder is ascending. See https://google.aip.dev/132#ordering.
+  pageSize: integer, Maximum number of functions to return per call.
+  pageToken: string, The value returned by the last `ListFunctionsResponse`; indicates that this is a continuation of a prior `ListFunctions` call, and that the system should return the next page of data.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response for the `ListFunctions` method.
+  "functions": [ # The functions that match the request.
+    { # Describes a Cloud Function that contains user computation executed in response to an event. It encapsulates function and trigger configurations.
+      "buildConfig": { # Describes the Build step of the function that builds a container from the given source. # Describes the Build step of the function that builds a container from the given source.
+        "build": "A String", # Output only. The Cloud Build name of the latest successful deployment of the function.
+        "dockerRepository": "A String", # Optional. User managed repository created in Artifact Registry optionally with a customer managed encryption key. This is the repository to which the function docker image will be pushed after it is built by Cloud Build. If unspecified, GCF will create and use a repository named 'gcf-artifacts' for every deployed region. It must match the pattern `projects/{project}/locations/{location}/repositories/{repository}`. Cross-project repositories are not supported. Cross-location repositories are not supported. Repository format must be 'DOCKER'.
+        "entryPoint": "A String", # The name of the function (as defined in source code) that will be executed. Defaults to the resource name suffix, if not specified. For backward compatibility, if function with given name is not found, then the system will try to use function named "function". For Node.js this is name of a function exported by the module specified in `source_location`.
+        "environmentVariables": { # User-provided build-time environment variables for the function
+          "a_key": "A String",
+        },
+        "runtime": "A String", # The runtime in which to run the function. Required when deploying a new function, optional when updating an existing function. For a complete list of possible choices, see the [`gcloud` command reference](https://cloud.google.com/sdk/gcloud/reference/functions/deploy#--runtime).
+        "source": { # The location of the function source code. # The location of the function source code.
+          "repoSource": { # Location of the source in a Google Cloud Source Repository. # If provided, get the source from this location in a Cloud Source Repository.
+            "branchName": "A String", # Regex matching branches to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax
+            "commitSha": "A String", # Explicit commit SHA to build.
+            "dir": "A String", # Directory, relative to the source root, in which to run the build. This must be a relative path. If a step's `dir` is specified and is an absolute path, this value is ignored for that step's execution. eg. helloworld (no leading slash allowed)
+            "invertRegex": True or False, # Only trigger a build if the revision regex does NOT match the revision regex.
+            "projectId": "A String", # ID of the project that owns the Cloud Source Repository. If omitted, the project ID requesting the build is assumed.
+            "repoName": "A String", # Name of the Cloud Source Repository.
+            "tagName": "A String", # Regex matching tags to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax
+          },
+          "storageSource": { # Location of the source in an archive file in Google Cloud Storage. # If provided, get the source from this location in Google Cloud Storage.
+            "bucket": "A String", # Google Cloud Storage bucket containing the source (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
+            "generation": "A String", # Google Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used.
+            "object": "A String", # Google Cloud Storage object containing the source. This object must be a gzipped archive file (`.tar.gz`) containing source to build.
+          },
+        },
+        "sourceProvenance": { # Provenance of the source. Ways to find the original source, or verify that some source was used for this build. # Output only. A permanent fixed identifier for source.
+          "resolvedRepoSource": { # Location of the source in a Google Cloud Source Repository. # A copy of the build's `source.repo_source`, if exists, with any revisions resolved.
+            "branchName": "A String", # Regex matching branches to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax
+            "commitSha": "A String", # Explicit commit SHA to build.
+            "dir": "A String", # Directory, relative to the source root, in which to run the build. This must be a relative path. If a step's `dir` is specified and is an absolute path, this value is ignored for that step's execution. eg. helloworld (no leading slash allowed)
+            "invertRegex": True or False, # Only trigger a build if the revision regex does NOT match the revision regex.
+            "projectId": "A String", # ID of the project that owns the Cloud Source Repository. If omitted, the project ID requesting the build is assumed.
+            "repoName": "A String", # Name of the Cloud Source Repository.
+            "tagName": "A String", # Regex matching tags to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax
+          },
+          "resolvedStorageSource": { # Location of the source in an archive file in Google Cloud Storage. # A copy of the build's `source.storage_source`, if exists, with any generations resolved.
+            "bucket": "A String", # Google Cloud Storage bucket containing the source (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
+            "generation": "A String", # Google Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used.
+            "object": "A String", # Google Cloud Storage object containing the source. This object must be a gzipped archive file (`.tar.gz`) containing source to build.
+          },
+        },
+        "workerPool": "A String", # Name of the Cloud Build Custom Worker Pool that should be used to build the function. The format of this field is `projects/{project}/locations/{region}/workerPools/{workerPool}` where {project} and {region} are the project id and region respectively where the worker pool is defined and {workerPool} is the short name of the worker pool. If the project id is not the same as the function, then the Cloud Functions Service Agent (service-@gcf-admin-robot.iam.gserviceaccount.com) must be granted the role Cloud Build Custom Workers Builder (roles/cloudbuild.customworkers.builder) in the project.
+      },
+      "description": "A String", # User-provided description of a function.
+      "environment": "A String", # Describe whether the function is gen1 or gen2.
+      "eventTrigger": { # Describes EventTrigger, used to request events to be sent from another service. # An Eventarc trigger managed by Google Cloud Functions that fires events in response to a condition in another service.
+        "channel": "A String", # Optional. The name of the channel associated with the trigger in `projects/{project}/locations/{location}/channels/{channel}` format. You must provide a channel to receive events from Eventarc SaaS partners.
+        "eventFilters": [ # Criteria used to filter events.
+          { # Filters events based on exact matches on the CloudEvents attributes.
+            "attribute": "A String", # Required. The name of a CloudEvents attribute.
+            "operator": "A String", # Optional. The operator used for matching the events with the value of the filter. If not specified, only events that have an exact key-value pair specified in the filter are matched. The only allowed value is `match-path-pattern`.
+            "value": "A String", # Required. The value for the attribute.
+          },
+        ],
+        "eventType": "A String", # Required. The type of event to observe. For example: `google.cloud.audit.log.v1.written` or `google.cloud.pubsub.topic.v1.messagePublished`.
+        "pubsubTopic": "A String", # Optional. The name of a Pub/Sub topic in the same project that will be used as the transport topic for the event delivery. Format: `projects/{project}/topics/{topic}`. This is only valid for events of type `google.cloud.pubsub.topic.v1.messagePublished`. The topic provided here will not be deleted at function deletion.
+        "retryPolicy": "A String", # Optional. If unset, then defaults to ignoring failures (i.e. not retrying them).
+        "serviceAccountEmail": "A String", # Optional. The email of the trigger's service account. The service account must have permission to invoke Cloud Run services, the permission is `run.routes.invoke`. If empty, defaults to the Compute Engine default service account: `{project_number}-compute@developer.gserviceaccount.com`.
+        "trigger": "A String", # Output only. The resource name of the Eventarc trigger. The format of this field is `projects/{project}/locations/{region}/triggers/{trigger}`.
+        "triggerRegion": "A String", # The region that the trigger will be in. The trigger will only receive events originating in this region. It can be the same region as the function, a different region or multi-region, or the global region. If not provided, defaults to the same region as the function.
+      },
+      "labels": { # Labels associated with this Cloud Function.
+        "a_key": "A String",
+      },
+      "name": "A String", # A user-defined name of the function. Function names must be unique globally and match pattern `projects/*/locations/*/functions/*`
+      "serviceConfig": { # Describes the Service being deployed. Currently Supported : Cloud Run (fully managed). # Describes the Service being deployed. Currently deploys services to Cloud Run (fully managed).
+        "allTrafficOnLatestRevision": True or False, # Whether 100% of traffic is routed to the latest revision. On CreateFunction and UpdateFunction, when set to true, the revision being deployed will serve 100% of traffic, ignoring any traffic split settings, if any. On GetFunction, true will be returned if the latest revision is serving 100% of traffic.
+        "availableMemory": "A String", # The amount of memory available for a function. Defaults to 256M. Supported units are k, M, G, Mi, Gi. If no unit is supplied the value is interpreted as bytes. See https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/quantity.go a full description.
+        "environmentVariables": { # Environment variables that shall be available during function execution.
+          "a_key": "A String",
+        },
+        "ingressSettings": "A String", # The ingress settings for the function, controlling what traffic can reach it.
+        "maxInstanceCount": 42, # The limit on the maximum number of function instances that may coexist at a given time. In some cases, such as rapid traffic surges, Cloud Functions may, for a short period of time, create more instances than the specified max instances limit. If your function cannot tolerate this temporary behavior, you may want to factor in a safety margin and set a lower max instances value than your function can tolerate. See the [Max Instances](https://cloud.google.com/functions/docs/max-instances) Guide for more details.
+        "minInstanceCount": 42, # The limit on the minimum number of function instances that may coexist at a given time. Function instances are kept in idle state for a short period after they finished executing the request to reduce cold start time for subsequent requests. Setting a minimum instance count will ensure that the given number of instances are kept running in idle state always. This can help with cold start times when jump in incoming request count occurs after the idle instance would have been stopped in the default case.
+        "revision": "A String", # Output only. The name of service revision.
+        "secretEnvironmentVariables": [ # Secret environment variables configuration.
+          { # Configuration for a secret environment variable. It has the information necessary to fetch the secret value from secret manager and expose it as an environment variable.
+            "key": "A String", # Name of the environment variable.
+            "projectId": "A String", # Project identifier (preferably project number but can also be the project ID) of the project that contains the secret. If not set, it is assumed that the secret is in the same project as the function.
+            "secret": "A String", # Name of the secret in secret manager (not the full resource name).
+            "version": "A String", # Version of the secret (version number or the string 'latest'). It is recommended to use a numeric version for secret environment variables as any updates to the secret value is not reflected until new instances start.
+          },
+        ],
+        "secretVolumes": [ # Secret volumes configuration.
+          { # Configuration for a secret volume. It has the information necessary to fetch the secret value from secret manager and make it available as files mounted at the requested paths within the application container.
+            "mountPath": "A String", # The path within the container to mount the secret volume. For example, setting the mount_path as `/etc/secrets` would mount the secret value files under the `/etc/secrets` directory. This directory will also be completely shadowed and unavailable to mount any other secrets. Recommended mount path: /etc/secrets
+            "projectId": "A String", # Project identifier (preferably project number but can also be the project ID) of the project that contains the secret. If not set, it is assumed that the secret is in the same project as the function.
+            "secret": "A String", # Name of the secret in secret manager (not the full resource name).
+            "versions": [ # List of secret versions to mount for this secret. If empty, the `latest` version of the secret will be made available in a file named after the secret under the mount point.
+              { # Configuration for a single version.
+                "path": "A String", # Relative path of the file under the mount path where the secret value for this version will be fetched and made available. For example, setting the mount_path as '/etc/secrets' and path as `secret_foo` would mount the secret value file at `/etc/secrets/secret_foo`.
+                "version": "A String", # Version of the secret (version number or the string 'latest'). It is preferable to use `latest` version with secret volumes as secret value changes are reflected immediately.
+              },
+            ],
+          },
+        ],
+        "service": "A String", # Output only. Name of the service associated with a Function. The format of this field is `projects/{project}/locations/{region}/services/{service}`
+        "serviceAccountEmail": "A String", # The email of the service's service account. If empty, defaults to `{project_number}-compute@developer.gserviceaccount.com`.
+        "timeoutSeconds": 42, # The function execution timeout. Execution is considered failed and can be terminated if the function is not completed at the end of the timeout period. Defaults to 60 seconds.
+        "uri": "A String", # Output only. URI of the Service deployed.
+        "vpcConnector": "A String", # The Serverless VPC Access connector that this cloud function can connect to. The format of this field is `projects/*/locations/*/connectors/*`.
+        "vpcConnectorEgressSettings": "A String", # The egress settings for the connector, controlling what traffic is diverted through it.
+      },
+      "state": "A String", # Output only. State of the function.
+      "stateMessages": [ # Output only. State Messages for this Cloud Function.
+        { # Informational messages about the state of the Cloud Function or Operation.
+          "message": "A String", # The message.
+          "severity": "A String", # Severity of the state message.
+          "type": "A String", # One-word CamelCase type of the state message.
+        },
+      ],
+      "updateTime": "A String", # Output only. The last update timestamp of a Cloud Function.
+    },
+  ],
+  "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
+  "unreachable": [ # Locations that could not be reached. The response does not include any functions from these locations.
+    "A String",
+  ],
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(name, body=None, updateMask=None, x__xgafv=None) +
Updates existing function.
+
+Args:
+  name: string, A user-defined name of the function. Function names must be unique globally and match pattern `projects/*/locations/*/functions/*` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Describes a Cloud Function that contains user computation executed in response to an event. It encapsulates function and trigger configurations.
+  "buildConfig": { # Describes the Build step of the function that builds a container from the given source. # Describes the Build step of the function that builds a container from the given source.
+    "build": "A String", # Output only. The Cloud Build name of the latest successful deployment of the function.
+    "dockerRepository": "A String", # Optional. User managed repository created in Artifact Registry optionally with a customer managed encryption key. This is the repository to which the function docker image will be pushed after it is built by Cloud Build. If unspecified, GCF will create and use a repository named 'gcf-artifacts' for every deployed region. It must match the pattern `projects/{project}/locations/{location}/repositories/{repository}`. Cross-project repositories are not supported. Cross-location repositories are not supported. Repository format must be 'DOCKER'.
+    "entryPoint": "A String", # The name of the function (as defined in source code) that will be executed. Defaults to the resource name suffix, if not specified. For backward compatibility, if function with given name is not found, then the system will try to use function named "function". For Node.js this is name of a function exported by the module specified in `source_location`.
+    "environmentVariables": { # User-provided build-time environment variables for the function
+      "a_key": "A String",
+    },
+    "runtime": "A String", # The runtime in which to run the function. Required when deploying a new function, optional when updating an existing function. For a complete list of possible choices, see the [`gcloud` command reference](https://cloud.google.com/sdk/gcloud/reference/functions/deploy#--runtime).
+    "source": { # The location of the function source code. # The location of the function source code.
+      "repoSource": { # Location of the source in a Google Cloud Source Repository. # If provided, get the source from this location in a Cloud Source Repository.
+        "branchName": "A String", # Regex matching branches to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax
+        "commitSha": "A String", # Explicit commit SHA to build.
+        "dir": "A String", # Directory, relative to the source root, in which to run the build. This must be a relative path. If a step's `dir` is specified and is an absolute path, this value is ignored for that step's execution. eg. helloworld (no leading slash allowed)
+        "invertRegex": True or False, # Only trigger a build if the revision regex does NOT match the revision regex.
+        "projectId": "A String", # ID of the project that owns the Cloud Source Repository. If omitted, the project ID requesting the build is assumed.
+        "repoName": "A String", # Name of the Cloud Source Repository.
+        "tagName": "A String", # Regex matching tags to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax
+      },
+      "storageSource": { # Location of the source in an archive file in Google Cloud Storage. # If provided, get the source from this location in Google Cloud Storage.
+        "bucket": "A String", # Google Cloud Storage bucket containing the source (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
+        "generation": "A String", # Google Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used.
+        "object": "A String", # Google Cloud Storage object containing the source. This object must be a gzipped archive file (`.tar.gz`) containing source to build.
+      },
+    },
+    "sourceProvenance": { # Provenance of the source. Ways to find the original source, or verify that some source was used for this build. # Output only. A permanent fixed identifier for source.
+      "resolvedRepoSource": { # Location of the source in a Google Cloud Source Repository. # A copy of the build's `source.repo_source`, if exists, with any revisions resolved.
+        "branchName": "A String", # Regex matching branches to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax
+        "commitSha": "A String", # Explicit commit SHA to build.
+        "dir": "A String", # Directory, relative to the source root, in which to run the build. This must be a relative path. If a step's `dir` is specified and is an absolute path, this value is ignored for that step's execution. eg. helloworld (no leading slash allowed)
+        "invertRegex": True or False, # Only trigger a build if the revision regex does NOT match the revision regex.
+        "projectId": "A String", # ID of the project that owns the Cloud Source Repository. If omitted, the project ID requesting the build is assumed.
+        "repoName": "A String", # Name of the Cloud Source Repository.
+        "tagName": "A String", # Regex matching tags to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax
+      },
+      "resolvedStorageSource": { # Location of the source in an archive file in Google Cloud Storage. # A copy of the build's `source.storage_source`, if exists, with any generations resolved.
+        "bucket": "A String", # Google Cloud Storage bucket containing the source (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
+        "generation": "A String", # Google Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used.
+        "object": "A String", # Google Cloud Storage object containing the source. This object must be a gzipped archive file (`.tar.gz`) containing source to build.
+      },
+    },
+    "workerPool": "A String", # Name of the Cloud Build Custom Worker Pool that should be used to build the function. The format of this field is `projects/{project}/locations/{region}/workerPools/{workerPool}` where {project} and {region} are the project id and region respectively where the worker pool is defined and {workerPool} is the short name of the worker pool. If the project id is not the same as the function, then the Cloud Functions Service Agent (service-@gcf-admin-robot.iam.gserviceaccount.com) must be granted the role Cloud Build Custom Workers Builder (roles/cloudbuild.customworkers.builder) in the project.
+  },
+  "description": "A String", # User-provided description of a function.
+  "environment": "A String", # Describe whether the function is gen1 or gen2.
+  "eventTrigger": { # Describes EventTrigger, used to request events to be sent from another service. # An Eventarc trigger managed by Google Cloud Functions that fires events in response to a condition in another service.
+    "channel": "A String", # Optional. The name of the channel associated with the trigger in `projects/{project}/locations/{location}/channels/{channel}` format. You must provide a channel to receive events from Eventarc SaaS partners.
+    "eventFilters": [ # Criteria used to filter events.
+      { # Filters events based on exact matches on the CloudEvents attributes.
+        "attribute": "A String", # Required. The name of a CloudEvents attribute.
+        "operator": "A String", # Optional. The operator used for matching the events with the value of the filter. If not specified, only events that have an exact key-value pair specified in the filter are matched. The only allowed value is `match-path-pattern`.
+        "value": "A String", # Required. The value for the attribute.
+      },
+    ],
+    "eventType": "A String", # Required. The type of event to observe. For example: `google.cloud.audit.log.v1.written` or `google.cloud.pubsub.topic.v1.messagePublished`.
+    "pubsubTopic": "A String", # Optional. The name of a Pub/Sub topic in the same project that will be used as the transport topic for the event delivery. Format: `projects/{project}/topics/{topic}`. This is only valid for events of type `google.cloud.pubsub.topic.v1.messagePublished`. The topic provided here will not be deleted at function deletion.
+    "retryPolicy": "A String", # Optional. If unset, then defaults to ignoring failures (i.e. not retrying them).
+    "serviceAccountEmail": "A String", # Optional. The email of the trigger's service account. The service account must have permission to invoke Cloud Run services, the permission is `run.routes.invoke`. If empty, defaults to the Compute Engine default service account: `{project_number}-compute@developer.gserviceaccount.com`.
+    "trigger": "A String", # Output only. The resource name of the Eventarc trigger. The format of this field is `projects/{project}/locations/{region}/triggers/{trigger}`.
+    "triggerRegion": "A String", # The region that the trigger will be in. The trigger will only receive events originating in this region. It can be the same region as the function, a different region or multi-region, or the global region. If not provided, defaults to the same region as the function.
+  },
+  "labels": { # Labels associated with this Cloud Function.
+    "a_key": "A String",
+  },
+  "name": "A String", # A user-defined name of the function. Function names must be unique globally and match pattern `projects/*/locations/*/functions/*`
+  "serviceConfig": { # Describes the Service being deployed. Currently Supported : Cloud Run (fully managed). # Describes the Service being deployed. Currently deploys services to Cloud Run (fully managed).
+    "allTrafficOnLatestRevision": True or False, # Whether 100% of traffic is routed to the latest revision. On CreateFunction and UpdateFunction, when set to true, the revision being deployed will serve 100% of traffic, ignoring any traffic split settings, if any. On GetFunction, true will be returned if the latest revision is serving 100% of traffic.
+    "availableMemory": "A String", # The amount of memory available for a function. Defaults to 256M. Supported units are k, M, G, Mi, Gi. If no unit is supplied the value is interpreted as bytes. See https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/quantity.go a full description.
+    "environmentVariables": { # Environment variables that shall be available during function execution.
+      "a_key": "A String",
+    },
+    "ingressSettings": "A String", # The ingress settings for the function, controlling what traffic can reach it.
+    "maxInstanceCount": 42, # The limit on the maximum number of function instances that may coexist at a given time. In some cases, such as rapid traffic surges, Cloud Functions may, for a short period of time, create more instances than the specified max instances limit. If your function cannot tolerate this temporary behavior, you may want to factor in a safety margin and set a lower max instances value than your function can tolerate. See the [Max Instances](https://cloud.google.com/functions/docs/max-instances) Guide for more details.
+    "minInstanceCount": 42, # The limit on the minimum number of function instances that may coexist at a given time. Function instances are kept in idle state for a short period after they finished executing the request to reduce cold start time for subsequent requests. Setting a minimum instance count will ensure that the given number of instances are kept running in idle state always. This can help with cold start times when jump in incoming request count occurs after the idle instance would have been stopped in the default case.
+    "revision": "A String", # Output only. The name of service revision.
+    "secretEnvironmentVariables": [ # Secret environment variables configuration.
+      { # Configuration for a secret environment variable. It has the information necessary to fetch the secret value from secret manager and expose it as an environment variable.
+        "key": "A String", # Name of the environment variable.
+        "projectId": "A String", # Project identifier (preferably project number but can also be the project ID) of the project that contains the secret. If not set, it is assumed that the secret is in the same project as the function.
+        "secret": "A String", # Name of the secret in secret manager (not the full resource name).
+        "version": "A String", # Version of the secret (version number or the string 'latest'). It is recommended to use a numeric version for secret environment variables as any updates to the secret value is not reflected until new instances start.
+      },
+    ],
+    "secretVolumes": [ # Secret volumes configuration.
+      { # Configuration for a secret volume. It has the information necessary to fetch the secret value from secret manager and make it available as files mounted at the requested paths within the application container.
+        "mountPath": "A String", # The path within the container to mount the secret volume. For example, setting the mount_path as `/etc/secrets` would mount the secret value files under the `/etc/secrets` directory. This directory will also be completely shadowed and unavailable to mount any other secrets. Recommended mount path: /etc/secrets
+        "projectId": "A String", # Project identifier (preferably project number but can also be the project ID) of the project that contains the secret. If not set, it is assumed that the secret is in the same project as the function.
+        "secret": "A String", # Name of the secret in secret manager (not the full resource name).
+        "versions": [ # List of secret versions to mount for this secret. If empty, the `latest` version of the secret will be made available in a file named after the secret under the mount point.
+          { # Configuration for a single version.
+            "path": "A String", # Relative path of the file under the mount path where the secret value for this version will be fetched and made available. For example, setting the mount_path as '/etc/secrets' and path as `secret_foo` would mount the secret value file at `/etc/secrets/secret_foo`.
+            "version": "A String", # Version of the secret (version number or the string 'latest'). It is preferable to use `latest` version with secret volumes as secret value changes are reflected immediately.
+          },
+        ],
+      },
+    ],
+    "service": "A String", # Output only. Name of the service associated with a Function. The format of this field is `projects/{project}/locations/{region}/services/{service}`
+    "serviceAccountEmail": "A String", # The email of the service's service account. If empty, defaults to `{project_number}-compute@developer.gserviceaccount.com`.
+    "timeoutSeconds": 42, # The function execution timeout. Execution is considered failed and can be terminated if the function is not completed at the end of the timeout period. Defaults to 60 seconds.
+    "uri": "A String", # Output only. URI of the Service deployed.
+    "vpcConnector": "A String", # The Serverless VPC Access connector that this cloud function can connect to. The format of this field is `projects/*/locations/*/connectors/*`.
+    "vpcConnectorEgressSettings": "A String", # The egress settings for the connector, controlling what traffic is diverted through it.
+  },
+  "state": "A String", # Output only. State of the function.
+  "stateMessages": [ # Output only. State Messages for this Cloud Function.
+    { # Informational messages about the state of the Cloud Function or Operation.
+      "message": "A String", # The message.
+      "severity": "A String", # Severity of the state message.
+      "type": "A String", # One-word CamelCase type of the state message.
+    },
+  ],
+  "updateTime": "A String", # Output only. The last update timestamp of a Cloud Function.
+}
+
+  updateMask: string, The list of fields to be updated. If no field mask is provided, all provided fields in the request will be updated.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # 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.
+  "error": { # 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). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # 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.
+  },
+  "metadata": { # 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.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # 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}`.
+  "response": { # 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`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+
setIamPolicy(resource, body=None, x__xgafv=None)
Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
diff --git a/docs/dyn/cloudfunctions_v2.projects.locations.html b/docs/dyn/cloudfunctions_v2.projects.locations.html
index a410ab8a587..cb7f6932450 100644
--- a/docs/dyn/cloudfunctions_v2.projects.locations.html
+++ b/docs/dyn/cloudfunctions_v2.projects.locations.html
@@ -84,6 +84,11 @@ 

Instance Methods

Returns the operations Resource.

+

+ runtimes() +

+

Returns the runtimes Resource.

+

close()

Close httplib2 connections.

diff --git a/docs/dyn/cloudfunctions_v2.projects.locations.runtimes.html b/docs/dyn/cloudfunctions_v2.projects.locations.runtimes.html new file mode 100644 index 00000000000..9a5092b6c61 --- /dev/null +++ b/docs/dyn/cloudfunctions_v2.projects.locations.runtimes.html @@ -0,0 +1,119 @@ + + + +

Cloud Functions API . projects . locations . runtimes

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ list(parent, filter=None, x__xgafv=None)

+

Returns a list of runtimes that are supported for the requested project.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ list(parent, filter=None, x__xgafv=None) +
Returns a list of runtimes that are supported for the requested project.
+
+Args:
+  parent: string, Required. The project and location from which the runtimes should be listed, specified in the format `projects/*/locations/*` (required)
+  filter: string, The filter for Runtimes that match the filter expression, following the syntax outlined in https://google.aip.dev/160.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response for the `ListRuntimes` method.
+  "runtimes": [ # The runtimes that match the request.
+    { # Describes a runtime and any special information (e.g., deprecation status) related to it.
+      "displayName": "A String", # The user facing name, eg 'Go 1.13', 'Node.js 12', etc.
+      "environment": "A String", # The environment for the runtime.
+      "name": "A String", # The name of the runtime, e.g., 'go113', 'nodejs12', etc.
+      "stage": "A String", # The stage of life this runtime is in, e.g., BETA, GA, etc.
+      "warnings": [ # Warning messages, e.g., a deprecation warning.
+        "A String",
+      ],
+    },
+  ],
+}
+
+ + \ No newline at end of file diff --git a/googleapiclient/discovery_cache/documents/cloudfunctions.v1.json b/googleapiclient/discovery_cache/documents/cloudfunctions.v1.json index 59184ccafa3..a0790772a0d 100644 --- a/googleapiclient/discovery_cache/documents/cloudfunctions.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudfunctions.v1.json @@ -546,7 +546,7 @@ } } }, - "revision": "20220622", + "revision": "20220707", "rootUrl": "https://cloudfunctions.googleapis.com/", "schemas": { "AuditConfig": { @@ -964,6 +964,153 @@ }, "type": "object" }, + "GoogleCloudFunctionsV2OperationMetadata": { + "description": "Represents the metadata of the long-running operation.", + "id": "GoogleCloudFunctionsV2OperationMetadata", + "properties": { + "apiVersion": { + "description": "API version used to start the operation.", + "type": "string" + }, + "cancelRequested": { + "description": "Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", + "type": "boolean" + }, + "createTime": { + "description": "The time the operation was created.", + "format": "google-datetime", + "type": "string" + }, + "endTime": { + "description": "The time the operation finished running.", + "format": "google-datetime", + "type": "string" + }, + "requestResource": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "The original request that started the operation.", + "type": "object" + }, + "stages": { + "description": "Mechanism for reporting in-progress stages", + "items": { + "$ref": "GoogleCloudFunctionsV2Stage" + }, + "type": "array" + }, + "statusDetail": { + "description": "Human-readable status of the operation, if any.", + "type": "string" + }, + "target": { + "description": "Server-defined resource path for the target of the operation.", + "type": "string" + }, + "verb": { + "description": "Name of the verb executed by the operation.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudFunctionsV2Stage": { + "description": "Each Stage of the deployment process", + "id": "GoogleCloudFunctionsV2Stage", + "properties": { + "message": { + "description": "Message describing the Stage", + "type": "string" + }, + "name": { + "description": "Name of the Stage. This will be unique for each Stage.", + "enum": [ + "NAME_UNSPECIFIED", + "ARTIFACT_REGISTRY", + "BUILD", + "SERVICE", + "TRIGGER", + "SERVICE_ROLLBACK", + "TRIGGER_ROLLBACK" + ], + "enumDescriptions": [ + "Not specified. Invalid name.", + "Artifact Regsitry Stage", + "Build Stage", + "Service Stage", + "Trigger Stage", + "Service Rollback Stage", + "Trigger Rollback Stage" + ], + "type": "string" + }, + "resource": { + "description": "Resource of the Stage", + "type": "string" + }, + "resourceUri": { + "description": "Link to the current Stage resource", + "type": "string" + }, + "state": { + "description": "Current state of the Stage", + "enum": [ + "STATE_UNSPECIFIED", + "NOT_STARTED", + "IN_PROGRESS", + "COMPLETE" + ], + "enumDescriptions": [ + "Not specified. Invalid state.", + "Stage has not started.", + "Stage is in progress.", + "Stage has completed." + ], + "type": "string" + }, + "stateMessages": { + "description": "State messages from the current Stage.", + "items": { + "$ref": "GoogleCloudFunctionsV2StateMessage" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudFunctionsV2StateMessage": { + "description": "Informational messages about the state of the Cloud Function or Operation.", + "id": "GoogleCloudFunctionsV2StateMessage", + "properties": { + "message": { + "description": "The message.", + "type": "string" + }, + "severity": { + "description": "Severity of the state message.", + "enum": [ + "SEVERITY_UNSPECIFIED", + "ERROR", + "WARNING", + "INFO" + ], + "enumDescriptions": [ + "Not specified. Invalid severity.", + "ERROR-level severity.", + "WARNING-level severity.", + "INFO-level severity." + ], + "type": "string" + }, + "type": { + "description": "One-word CamelCase type of the state message.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudFunctionsV2alphaOperationMetadata": { "description": "Represents the metadata of the long-running operation.", "id": "GoogleCloudFunctionsV2alphaOperationMetadata", diff --git a/googleapiclient/discovery_cache/documents/cloudfunctions.v2.json b/googleapiclient/discovery_cache/documents/cloudfunctions.v2.json index 76654ed0a7e..a2b5db27120 100644 --- a/googleapiclient/discovery_cache/documents/cloudfunctions.v2.json +++ b/googleapiclient/discovery_cache/documents/cloudfunctions.v2.json @@ -154,6 +154,145 @@ "resources": { "functions": { "methods": { + "create": { + "description": "Creates a new function. If a function with the given name already exists in the specified project, the long running operation will return `ALREADY_EXISTS` error.", + "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/functions", + "httpMethod": "POST", + "id": "cloudfunctions.projects.locations.functions.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "functionId": { + "description": "The ID to use for the function, which will become the final component of the function's resource name. This value should be 4-63 characters, and valid characters are /a-z-/.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The project and location in which the function should be created, specified in the format `projects/*/locations/*`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+parent}/functions", + "request": { + "$ref": "Function" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a function with the given name from the specified project. If the given function is used by some trigger, the trigger will be updated to remove this function.", + "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}", + "httpMethod": "DELETE", + "id": "cloudfunctions.projects.locations.functions.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the function which should be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "generateDownloadUrl": { + "description": "Returns a signed URL for downloading deployed function source code. The URL is only valid for a limited period and should be used within 30 minutes of generation. For more information about the signed URL usage see: https://cloud.google.com/storage/docs/access-control/signed-urls", + "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}:generateDownloadUrl", + "httpMethod": "POST", + "id": "cloudfunctions.projects.locations.functions.generateDownloadUrl", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of function for which source code Google Cloud Storage signed URL should be generated.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}:generateDownloadUrl", + "request": { + "$ref": "GenerateDownloadUrlRequest" + }, + "response": { + "$ref": "GenerateDownloadUrlResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "generateUploadUrl": { + "description": "Returns a signed URL for uploading a function source code. For more information about the signed URL usage see: https://cloud.google.com/storage/docs/access-control/signed-urls. Once the function source code upload is complete, the used signed URL should be provided in CreateFunction or UpdateFunction request as a reference to the function source code. When uploading source code to the generated signed URL, please follow these restrictions: * Source file type should be a zip file. * No credentials should be attached - the signed URLs provide access to the target bucket using internal service identity; if credentials were attached, the identity from the credentials would be used, but that identity does not have permissions to upload files to the URL. When making a HTTP PUT request, these two headers need to be specified: * `content-type: application/zip` And this header SHOULD NOT be specified: * `Authorization: Bearer YOUR_TOKEN`", + "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/functions:generateUploadUrl", + "httpMethod": "POST", + "id": "cloudfunctions.projects.locations.functions.generateUploadUrl", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The project and location in which the Google Cloud Storage signed URL should be generated, specified in the format `projects/*/locations/*`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+parent}/functions:generateUploadUrl", + "request": { + "$ref": "GenerateUploadUrlRequest" + }, + "response": { + "$ref": "GenerateUploadUrlResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Returns a function with the given name from the requested project.", + "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}", + "httpMethod": "GET", + "id": "cloudfunctions.projects.locations.functions.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the function which details should be obtained.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}", + "response": { + "$ref": "Function" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "getIamPolicy": { "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}:getIamPolicy", @@ -185,6 +324,86 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "list": { + "description": "Returns a list of functions that belong to the requested project.", + "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/functions", + "httpMethod": "GET", + "id": "cloudfunctions.projects.locations.functions.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "The filter for Functions that match the filter expression, following the syntax outlined in https://google.aip.dev/160.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "The sorting order of the resources returned. Value should be a comma separated list of fields. The default sorting oder is ascending. See https://google.aip.dev/132#ordering.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Maximum number of functions to return per call.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The value returned by the last `ListFunctionsResponse`; indicates that this is a continuation of a prior `ListFunctions` call, and that the system should return the next page of data.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The project and location from which the function should be listed, specified in the format `projects/*/locations/*` If you want to list functions in all locations, use \"-\" in place of a location. When listing functions in all locations, if one or more location(s) are unreachable, the response will contain functions from all reachable locations along with the names of any unreachable locations.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+parent}/functions", + "response": { + "$ref": "ListFunctionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates existing function.", + "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}", + "httpMethod": "PATCH", + "id": "cloudfunctions.projects.locations.functions.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "A user-defined name of the function. Function names must be unique globally and match pattern `projects/*/locations/*/functions/*`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "The list of fields to be updated. If no field mask is provided, all provided fields in the request will be updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v2/{+name}", + "request": { + "$ref": "Function" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "setIamPolicy": { "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}:setIamPolicy", @@ -312,13 +531,47 @@ ] } } + }, + "runtimes": { + "methods": { + "list": { + "description": "Returns a list of runtimes that are supported for the requested project.", + "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/runtimes", + "httpMethod": "GET", + "id": "cloudfunctions.projects.locations.runtimes.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "The filter for Runtimes that match the filter expression, following the syntax outlined in https://google.aip.dev/160.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The project and location from which the runtimes should be listed, specified in the format `projects/*/locations/*`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+parent}/runtimes", + "response": { + "$ref": "ListRuntimesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } } } } } } }, - "revision": "20220622", + "revision": "20220707", "rootUrl": "https://cloudfunctions.googleapis.com/", "schemas": { "AuditConfig": { @@ -350,65 +603,449 @@ }, "type": "array" }, - "logType": { - "description": "The log type that this config enables.", + "logType": { + "description": "The log type that this config enables.", + "enum": [ + "LOG_TYPE_UNSPECIFIED", + "ADMIN_READ", + "DATA_WRITE", + "DATA_READ" + ], + "enumDescriptions": [ + "Default case. Should never be this.", + "Admin reads. Example: CloudIAM getIamPolicy", + "Data writes. Example: CloudSQL Users create", + "Data reads. Example: CloudSQL Users list" + ], + "type": "string" + } + }, + "type": "object" + }, + "Binding": { + "description": "Associates `members`, or principals, with a `role`.", + "id": "Binding", + "properties": { + "condition": { + "$ref": "Expr", + "description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)." + }, + "members": { + "description": "Specifies the principals requesting access for a 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. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ", + "items": { + "type": "string" + }, + "type": "array" + }, + "role": { + "description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.", + "type": "string" + } + }, + "type": "object" + }, + "BuildConfig": { + "description": "Describes the Build step of the function that builds a container from the given source.", + "id": "BuildConfig", + "properties": { + "build": { + "description": "Output only. The Cloud Build name of the latest successful deployment of the function.", + "readOnly": true, + "type": "string" + }, + "dockerRepository": { + "description": "Optional. User managed repository created in Artifact Registry optionally with a customer managed encryption key. This is the repository to which the function docker image will be pushed after it is built by Cloud Build. If unspecified, GCF will create and use a repository named 'gcf-artifacts' for every deployed region. It must match the pattern `projects/{project}/locations/{location}/repositories/{repository}`. Cross-project repositories are not supported. Cross-location repositories are not supported. Repository format must be 'DOCKER'.", + "type": "string" + }, + "entryPoint": { + "description": "The name of the function (as defined in source code) that will be executed. Defaults to the resource name suffix, if not specified. For backward compatibility, if function with given name is not found, then the system will try to use function named \"function\". For Node.js this is name of a function exported by the module specified in `source_location`.", + "type": "string" + }, + "environmentVariables": { + "additionalProperties": { + "type": "string" + }, + "description": "User-provided build-time environment variables for the function", + "type": "object" + }, + "runtime": { + "description": "The runtime in which to run the function. Required when deploying a new function, optional when updating an existing function. For a complete list of possible choices, see the [`gcloud` command reference](https://cloud.google.com/sdk/gcloud/reference/functions/deploy#--runtime).", + "type": "string" + }, + "source": { + "$ref": "Source", + "description": "The location of the function source code." + }, + "sourceProvenance": { + "$ref": "SourceProvenance", + "description": "Output only. A permanent fixed identifier for source.", + "readOnly": true + }, + "workerPool": { + "description": "Name of the Cloud Build Custom Worker Pool that should be used to build the function. The format of this field is `projects/{project}/locations/{region}/workerPools/{workerPool}` where {project} and {region} are the project id and region respectively where the worker pool is defined and {workerPool} is the short name of the worker pool. If the project id is not the same as the function, then the Cloud Functions Service Agent (service-@gcf-admin-robot.iam.gserviceaccount.com) must be granted the role Cloud Build Custom Workers Builder (roles/cloudbuild.customworkers.builder) in the project.", + "type": "string" + } + }, + "type": "object" + }, + "EventFilter": { + "description": "Filters events based on exact matches on the CloudEvents attributes.", + "id": "EventFilter", + "properties": { + "attribute": { + "description": "Required. The name of a CloudEvents attribute.", + "type": "string" + }, + "operator": { + "description": "Optional. The operator used for matching the events with the value of the filter. If not specified, only events that have an exact key-value pair specified in the filter are matched. The only allowed value is `match-path-pattern`.", + "type": "string" + }, + "value": { + "description": "Required. The value for the attribute.", + "type": "string" + } + }, + "type": "object" + }, + "EventTrigger": { + "description": "Describes EventTrigger, used to request events to be sent from another service.", + "id": "EventTrigger", + "properties": { + "channel": { + "description": "Optional. The name of the channel associated with the trigger in `projects/{project}/locations/{location}/channels/{channel}` format. You must provide a channel to receive events from Eventarc SaaS partners.", + "type": "string" + }, + "eventFilters": { + "description": "Criteria used to filter events.", + "items": { + "$ref": "EventFilter" + }, + "type": "array" + }, + "eventType": { + "description": "Required. The type of event to observe. For example: `google.cloud.audit.log.v1.written` or `google.cloud.pubsub.topic.v1.messagePublished`.", + "type": "string" + }, + "pubsubTopic": { + "description": "Optional. The name of a Pub/Sub topic in the same project that will be used as the transport topic for the event delivery. Format: `projects/{project}/topics/{topic}`. This is only valid for events of type `google.cloud.pubsub.topic.v1.messagePublished`. The topic provided here will not be deleted at function deletion.", + "type": "string" + }, + "retryPolicy": { + "description": "Optional. If unset, then defaults to ignoring failures (i.e. not retrying them).", + "enum": [ + "RETRY_POLICY_UNSPECIFIED", + "RETRY_POLICY_DO_NOT_RETRY", + "RETRY_POLICY_RETRY" + ], + "enumDescriptions": [ + "Not specified.", + "Do not retry.", + "Retry on any failure, retry up to 7 days with an exponential backoff (capped at 10 seconds)." + ], + "type": "string" + }, + "serviceAccountEmail": { + "description": "Optional. The email of the trigger's service account. The service account must have permission to invoke Cloud Run services, the permission is `run.routes.invoke`. If empty, defaults to the Compute Engine default service account: `{project_number}-compute@developer.gserviceaccount.com`.", + "type": "string" + }, + "trigger": { + "description": "Output only. The resource name of the Eventarc trigger. The format of this field is `projects/{project}/locations/{region}/triggers/{trigger}`.", + "readOnly": true, + "type": "string" + }, + "triggerRegion": { + "description": "The region that the trigger will be in. The trigger will only receive events originating in this region. It can be the same region as the function, a different region or multi-region, or the global region. If not provided, defaults to the same region as the function.", + "type": "string" + } + }, + "type": "object" + }, + "Expr": { + "description": "Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: \"Summary size limit\" description: \"Determines if a summary is less than 100 chars\" expression: \"document.summary.size() < 100\" Example (Equality): title: \"Requestor is owner\" description: \"Determines if requestor is the document owner\" expression: \"document.owner == request.auth.claims.email\" Example (Logic): title: \"Public documents\" description: \"Determine whether the document should be publicly visible\" expression: \"document.type != 'private' && document.type != 'internal'\" Example (Data Manipulation): title: \"Notification string\" description: \"Create a notification string with a timestamp.\" expression: \"'New message received at ' + string(document.create_time)\" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.", + "id": "Expr", + "properties": { + "description": { + "description": "Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.", + "type": "string" + }, + "expression": { + "description": "Textual representation of an expression in Common Expression Language syntax.", + "type": "string" + }, + "location": { + "description": "Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.", + "type": "string" + }, + "title": { + "description": "Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.", + "type": "string" + } + }, + "type": "object" + }, + "Function": { + "description": "Describes a Cloud Function that contains user computation executed in response to an event. It encapsulates function and trigger configurations.", + "id": "Function", + "properties": { + "buildConfig": { + "$ref": "BuildConfig", + "description": "Describes the Build step of the function that builds a container from the given source." + }, + "description": { + "description": "User-provided description of a function.", + "type": "string" + }, + "environment": { + "description": "Describe whether the function is gen1 or gen2.", + "enum": [ + "ENVIRONMENT_UNSPECIFIED", + "GEN_1", + "GEN_2" + ], + "enumDescriptions": [ + "Unspecified", + "Gen 1", + "Gen 2" + ], + "type": "string" + }, + "eventTrigger": { + "$ref": "EventTrigger", + "description": "An Eventarc trigger managed by Google Cloud Functions that fires events in response to a condition in another service." + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Labels associated with this Cloud Function.", + "type": "object" + }, + "name": { + "description": "A user-defined name of the function. Function names must be unique globally and match pattern `projects/*/locations/*/functions/*`", + "type": "string" + }, + "serviceConfig": { + "$ref": "ServiceConfig", + "description": "Describes the Service being deployed. Currently deploys services to Cloud Run (fully managed)." + }, + "state": { + "description": "Output only. State of the function.", + "enum": [ + "STATE_UNSPECIFIED", + "ACTIVE", + "FAILED", + "DEPLOYING", + "DELETING", + "UNKNOWN" + ], + "enumDescriptions": [ + "Not specified. Invalid state.", + "Function has been successfully deployed and is serving.", + "Function deployment failed and the function is not serving.", + "Function is being created or updated.", + "Function is being deleted.", + "Function deployment failed and the function serving state is undefined. The function should be updated or deleted to move it out of this state." + ], + "readOnly": true, + "type": "string" + }, + "stateMessages": { + "description": "Output only. State Messages for this Cloud Function.", + "items": { + "$ref": "GoogleCloudFunctionsV2StateMessage" + }, + "readOnly": true, + "type": "array" + }, + "updateTime": { + "description": "Output only. The last update timestamp of a Cloud Function.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GenerateDownloadUrlRequest": { + "description": "Request of `GenerateDownloadUrl` method.", + "id": "GenerateDownloadUrlRequest", + "properties": {}, + "type": "object" + }, + "GenerateDownloadUrlResponse": { + "description": "Response of `GenerateDownloadUrl` method.", + "id": "GenerateDownloadUrlResponse", + "properties": { + "downloadUrl": { + "description": "The generated Google Cloud Storage signed URL that should be used for function source code download.", + "type": "string" + } + }, + "type": "object" + }, + "GenerateUploadUrlRequest": { + "description": "Request of `GenerateSourceUploadUrl` method.", + "id": "GenerateUploadUrlRequest", + "properties": {}, + "type": "object" + }, + "GenerateUploadUrlResponse": { + "description": "Response of `GenerateSourceUploadUrl` method.", + "id": "GenerateUploadUrlResponse", + "properties": { + "storageSource": { + "$ref": "StorageSource", + "description": "The location of the source code in the upload bucket. Once the archive is uploaded using the `upload_url` use this field to set the `function.build_config.source.storage_source` during CreateFunction and UpdateFunction. Generation defaults to 0, as Cloud Storage provides a new generation only upon uploading a new object or version of an object." + }, + "uploadUrl": { + "description": "The generated Google Cloud Storage signed URL that should be used for a function source code upload. The uploaded file should be a zip archive which contains a function.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudFunctionsV2OperationMetadata": { + "description": "Represents the metadata of the long-running operation.", + "id": "GoogleCloudFunctionsV2OperationMetadata", + "properties": { + "apiVersion": { + "description": "API version used to start the operation.", + "type": "string" + }, + "cancelRequested": { + "description": "Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", + "type": "boolean" + }, + "createTime": { + "description": "The time the operation was created.", + "format": "google-datetime", + "type": "string" + }, + "endTime": { + "description": "The time the operation finished running.", + "format": "google-datetime", + "type": "string" + }, + "requestResource": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "The original request that started the operation.", + "type": "object" + }, + "stages": { + "description": "Mechanism for reporting in-progress stages", + "items": { + "$ref": "GoogleCloudFunctionsV2Stage" + }, + "type": "array" + }, + "statusDetail": { + "description": "Human-readable status of the operation, if any.", + "type": "string" + }, + "target": { + "description": "Server-defined resource path for the target of the operation.", + "type": "string" + }, + "verb": { + "description": "Name of the verb executed by the operation.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudFunctionsV2Stage": { + "description": "Each Stage of the deployment process", + "id": "GoogleCloudFunctionsV2Stage", + "properties": { + "message": { + "description": "Message describing the Stage", + "type": "string" + }, + "name": { + "description": "Name of the Stage. This will be unique for each Stage.", + "enum": [ + "NAME_UNSPECIFIED", + "ARTIFACT_REGISTRY", + "BUILD", + "SERVICE", + "TRIGGER", + "SERVICE_ROLLBACK", + "TRIGGER_ROLLBACK" + ], + "enumDescriptions": [ + "Not specified. Invalid name.", + "Artifact Regsitry Stage", + "Build Stage", + "Service Stage", + "Trigger Stage", + "Service Rollback Stage", + "Trigger Rollback Stage" + ], + "type": "string" + }, + "resource": { + "description": "Resource of the Stage", + "type": "string" + }, + "resourceUri": { + "description": "Link to the current Stage resource", + "type": "string" + }, + "state": { + "description": "Current state of the Stage", "enum": [ - "LOG_TYPE_UNSPECIFIED", - "ADMIN_READ", - "DATA_WRITE", - "DATA_READ" + "STATE_UNSPECIFIED", + "NOT_STARTED", + "IN_PROGRESS", + "COMPLETE" ], "enumDescriptions": [ - "Default case. Should never be this.", - "Admin reads. Example: CloudIAM getIamPolicy", - "Data writes. Example: CloudSQL Users create", - "Data reads. Example: CloudSQL Users list" + "Not specified. Invalid state.", + "Stage has not started.", + "Stage is in progress.", + "Stage has completed." ], "type": "string" - } - }, - "type": "object" - }, - "Binding": { - "description": "Associates `members`, or principals, with a `role`.", - "id": "Binding", - "properties": { - "condition": { - "$ref": "Expr", - "description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)." }, - "members": { - "description": "Specifies the principals requesting access for a 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. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ", + "stateMessages": { + "description": "State messages from the current Stage.", "items": { - "type": "string" + "$ref": "GoogleCloudFunctionsV2StateMessage" }, "type": "array" - }, - "role": { - "description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.", - "type": "string" } }, "type": "object" }, - "Expr": { - "description": "Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: \"Summary size limit\" description: \"Determines if a summary is less than 100 chars\" expression: \"document.summary.size() < 100\" Example (Equality): title: \"Requestor is owner\" description: \"Determines if requestor is the document owner\" expression: \"document.owner == request.auth.claims.email\" Example (Logic): title: \"Public documents\" description: \"Determine whether the document should be publicly visible\" expression: \"document.type != 'private' && document.type != 'internal'\" Example (Data Manipulation): title: \"Notification string\" description: \"Create a notification string with a timestamp.\" expression: \"'New message received at ' + string(document.create_time)\" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.", - "id": "Expr", + "GoogleCloudFunctionsV2StateMessage": { + "description": "Informational messages about the state of the Cloud Function or Operation.", + "id": "GoogleCloudFunctionsV2StateMessage", "properties": { - "description": { - "description": "Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.", - "type": "string" - }, - "expression": { - "description": "Textual representation of an expression in Common Expression Language syntax.", + "message": { + "description": "The message.", "type": "string" }, - "location": { - "description": "Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.", + "severity": { + "description": "Severity of the state message.", + "enum": [ + "SEVERITY_UNSPECIFIED", + "ERROR", + "WARNING", + "INFO" + ], + "enumDescriptions": [ + "Not specified. Invalid severity.", + "ERROR-level severity.", + "WARNING-level severity.", + "INFO-level severity." + ], "type": "string" }, - "title": { - "description": "Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.", + "type": { + "description": "One-word CamelCase type of the state message.", "type": "string" } }, @@ -708,6 +1345,31 @@ }, "type": "object" }, + "ListFunctionsResponse": { + "description": "Response for the `ListFunctions` method.", + "id": "ListFunctionsResponse", + "properties": { + "functions": { + "description": "The functions that match the request.", + "items": { + "$ref": "Function" + }, + "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" + }, + "unreachable": { + "description": "Locations that could not be reached. The response does not include any functions from these locations.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "ListLocationsResponse": { "description": "The response message for Locations.ListLocations.", "id": "ListLocationsResponse", @@ -744,6 +1406,20 @@ }, "type": "object" }, + "ListRuntimesResponse": { + "description": "Response for the `ListRuntimes` method.", + "id": "ListRuntimesResponse", + "properties": { + "runtimes": { + "description": "The runtimes that match the request.", + "items": { + "$ref": "Runtime" + }, + "type": "array" + } + }, + "type": "object" + }, "Location": { "description": "A resource that represents Google Cloud Platform location.", "id": "Location", @@ -901,6 +1577,267 @@ }, "type": "object" }, + "RepoSource": { + "description": "Location of the source in a Google Cloud Source Repository.", + "id": "RepoSource", + "properties": { + "branchName": { + "description": "Regex matching branches to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax", + "type": "string" + }, + "commitSha": { + "description": "Explicit commit SHA to build.", + "type": "string" + }, + "dir": { + "description": "Directory, relative to the source root, in which to run the build. This must be a relative path. If a step's `dir` is specified and is an absolute path, this value is ignored for that step's execution. eg. helloworld (no leading slash allowed)", + "type": "string" + }, + "invertRegex": { + "description": "Only trigger a build if the revision regex does NOT match the revision regex.", + "type": "boolean" + }, + "projectId": { + "description": "ID of the project that owns the Cloud Source Repository. If omitted, the project ID requesting the build is assumed.", + "type": "string" + }, + "repoName": { + "description": "Name of the Cloud Source Repository.", + "type": "string" + }, + "tagName": { + "description": "Regex matching tags to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax", + "type": "string" + } + }, + "type": "object" + }, + "Runtime": { + "description": "Describes a runtime and any special information (e.g., deprecation status) related to it.", + "id": "Runtime", + "properties": { + "displayName": { + "description": "The user facing name, eg 'Go 1.13', 'Node.js 12', etc.", + "type": "string" + }, + "environment": { + "description": "The environment for the runtime.", + "enum": [ + "ENVIRONMENT_UNSPECIFIED", + "GEN_1", + "GEN_2" + ], + "enumDescriptions": [ + "Unspecified", + "Gen 1", + "Gen 2" + ], + "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" + ], + "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." + ], + "type": "string" + }, + "warnings": { + "description": "Warning messages, e.g., a deprecation warning.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "SecretEnvVar": { + "description": "Configuration for a secret environment variable. It has the information necessary to fetch the secret value from secret manager and expose it as an environment variable.", + "id": "SecretEnvVar", + "properties": { + "key": { + "description": "Name of the environment variable.", + "type": "string" + }, + "projectId": { + "description": "Project identifier (preferably project number but can also be the project ID) of the project that contains the secret. If not set, it is assumed that the secret is in the same project as the function.", + "type": "string" + }, + "secret": { + "description": "Name of the secret in secret manager (not the full resource name).", + "type": "string" + }, + "version": { + "description": "Version of the secret (version number or the string 'latest'). It is recommended to use a numeric version for secret environment variables as any updates to the secret value is not reflected until new instances start.", + "type": "string" + } + }, + "type": "object" + }, + "SecretVersion": { + "description": "Configuration for a single version.", + "id": "SecretVersion", + "properties": { + "path": { + "description": "Relative path of the file under the mount path where the secret value for this version will be fetched and made available. For example, setting the mount_path as '/etc/secrets' and path as `secret_foo` would mount the secret value file at `/etc/secrets/secret_foo`.", + "type": "string" + }, + "version": { + "description": "Version of the secret (version number or the string 'latest'). It is preferable to use `latest` version with secret volumes as secret value changes are reflected immediately.", + "type": "string" + } + }, + "type": "object" + }, + "SecretVolume": { + "description": "Configuration for a secret volume. It has the information necessary to fetch the secret value from secret manager and make it available as files mounted at the requested paths within the application container.", + "id": "SecretVolume", + "properties": { + "mountPath": { + "description": "The path within the container to mount the secret volume. For example, setting the mount_path as `/etc/secrets` would mount the secret value files under the `/etc/secrets` directory. This directory will also be completely shadowed and unavailable to mount any other secrets. Recommended mount path: /etc/secrets", + "type": "string" + }, + "projectId": { + "description": "Project identifier (preferably project number but can also be the project ID) of the project that contains the secret. If not set, it is assumed that the secret is in the same project as the function.", + "type": "string" + }, + "secret": { + "description": "Name of the secret in secret manager (not the full resource name).", + "type": "string" + }, + "versions": { + "description": "List of secret versions to mount for this secret. If empty, the `latest` version of the secret will be made available in a file named after the secret under the mount point.", + "items": { + "$ref": "SecretVersion" + }, + "type": "array" + } + }, + "type": "object" + }, + "ServiceConfig": { + "description": "Describes the Service being deployed. Currently Supported : Cloud Run (fully managed).", + "id": "ServiceConfig", + "properties": { + "allTrafficOnLatestRevision": { + "description": "Whether 100% of traffic is routed to the latest revision. On CreateFunction and UpdateFunction, when set to true, the revision being deployed will serve 100% of traffic, ignoring any traffic split settings, if any. On GetFunction, true will be returned if the latest revision is serving 100% of traffic.", + "type": "boolean" + }, + "availableMemory": { + "description": "The amount of memory available for a function. Defaults to 256M. Supported units are k, M, G, Mi, Gi. If no unit is supplied the value is interpreted as bytes. See https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/quantity.go a full description.", + "type": "string" + }, + "environmentVariables": { + "additionalProperties": { + "type": "string" + }, + "description": "Environment variables that shall be available during function execution.", + "type": "object" + }, + "ingressSettings": { + "description": "The ingress settings for the function, controlling what traffic can reach it.", + "enum": [ + "INGRESS_SETTINGS_UNSPECIFIED", + "ALLOW_ALL", + "ALLOW_INTERNAL_ONLY", + "ALLOW_INTERNAL_AND_GCLB" + ], + "enumDescriptions": [ + "Unspecified.", + "Allow HTTP traffic from public and private sources.", + "Allow HTTP traffic from only private VPC sources.", + "Allow HTTP traffic from private VPC sources and through GCLB." + ], + "type": "string" + }, + "maxInstanceCount": { + "description": "The limit on the maximum number of function instances that may coexist at a given time. In some cases, such as rapid traffic surges, Cloud Functions may, for a short period of time, create more instances than the specified max instances limit. If your function cannot tolerate this temporary behavior, you may want to factor in a safety margin and set a lower max instances value than your function can tolerate. See the [Max Instances](https://cloud.google.com/functions/docs/max-instances) Guide for more details.", + "format": "int32", + "type": "integer" + }, + "minInstanceCount": { + "description": "The limit on the minimum number of function instances that may coexist at a given time. Function instances are kept in idle state for a short period after they finished executing the request to reduce cold start time for subsequent requests. Setting a minimum instance count will ensure that the given number of instances are kept running in idle state always. This can help with cold start times when jump in incoming request count occurs after the idle instance would have been stopped in the default case.", + "format": "int32", + "type": "integer" + }, + "revision": { + "description": "Output only. The name of service revision.", + "readOnly": true, + "type": "string" + }, + "secretEnvironmentVariables": { + "description": "Secret environment variables configuration.", + "items": { + "$ref": "SecretEnvVar" + }, + "type": "array" + }, + "secretVolumes": { + "description": "Secret volumes configuration.", + "items": { + "$ref": "SecretVolume" + }, + "type": "array" + }, + "service": { + "description": "Output only. Name of the service associated with a Function. The format of this field is `projects/{project}/locations/{region}/services/{service}`", + "readOnly": true, + "type": "string" + }, + "serviceAccountEmail": { + "description": "The email of the service's service account. If empty, defaults to `{project_number}-compute@developer.gserviceaccount.com`.", + "type": "string" + }, + "timeoutSeconds": { + "description": "The function execution timeout. Execution is considered failed and can be terminated if the function is not completed at the end of the timeout period. Defaults to 60 seconds.", + "format": "int32", + "type": "integer" + }, + "uri": { + "description": "Output only. URI of the Service deployed.", + "readOnly": true, + "type": "string" + }, + "vpcConnector": { + "description": "The Serverless VPC Access connector that this cloud function can connect to. The format of this field is `projects/*/locations/*/connectors/*`.", + "type": "string" + }, + "vpcConnectorEgressSettings": { + "description": "The egress settings for the connector, controlling what traffic is diverted through it.", + "enum": [ + "VPC_CONNECTOR_EGRESS_SETTINGS_UNSPECIFIED", + "PRIVATE_RANGES_ONLY", + "ALL_TRAFFIC" + ], + "enumDescriptions": [ + "Unspecified.", + "Use the VPC Access Connector only for private IP space from RFC1918.", + "Force the use of VPC Access Connector for all egress traffic from the function." + ], + "type": "string" + } + }, + "type": "object" + }, "SetIamPolicyRequest": { "description": "Request message for `SetIamPolicy` method.", "id": "SetIamPolicyRequest", @@ -917,6 +1854,36 @@ }, "type": "object" }, + "Source": { + "description": "The location of the function source code.", + "id": "Source", + "properties": { + "repoSource": { + "$ref": "RepoSource", + "description": "If provided, get the source from this location in a Cloud Source Repository." + }, + "storageSource": { + "$ref": "StorageSource", + "description": "If provided, get the source from this location in Google Cloud Storage." + } + }, + "type": "object" + }, + "SourceProvenance": { + "description": "Provenance of the source. Ways to find the original source, or verify that some source was used for this build.", + "id": "SourceProvenance", + "properties": { + "resolvedRepoSource": { + "$ref": "RepoSource", + "description": "A copy of the build's `source.repo_source`, if exists, with any revisions resolved." + }, + "resolvedStorageSource": { + "$ref": "StorageSource", + "description": "A copy of the build's `source.storage_source`, if exists, with any generations resolved." + } + }, + "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", @@ -944,6 +1911,26 @@ }, "type": "object" }, + "StorageSource": { + "description": "Location of the source in an archive file in Google Cloud Storage.", + "id": "StorageSource", + "properties": { + "bucket": { + "description": "Google Cloud Storage bucket containing the source (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).", + "type": "string" + }, + "generation": { + "description": "Google Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used.", + "format": "int64", + "type": "string" + }, + "object": { + "description": "Google Cloud Storage object containing the source. This object must be a gzipped archive file (`.tar.gz`) containing source to build.", + "type": "string" + } + }, + "type": "object" + }, "TestIamPermissionsRequest": { "description": "Request message for `TestIamPermissions` method.", "id": "TestIamPermissionsRequest", diff --git a/googleapiclient/discovery_cache/documents/cloudfunctions.v2alpha.json b/googleapiclient/discovery_cache/documents/cloudfunctions.v2alpha.json index 17d806e3a87..e5992b6a281 100644 --- a/googleapiclient/discovery_cache/documents/cloudfunctions.v2alpha.json +++ b/googleapiclient/discovery_cache/documents/cloudfunctions.v2alpha.json @@ -571,7 +571,7 @@ } } }, - "revision": "20220622", + "revision": "20220707", "rootUrl": "https://cloudfunctions.googleapis.com/", "schemas": { "AuditConfig": { @@ -904,6 +904,153 @@ }, "type": "object" }, + "GoogleCloudFunctionsV2OperationMetadata": { + "description": "Represents the metadata of the long-running operation.", + "id": "GoogleCloudFunctionsV2OperationMetadata", + "properties": { + "apiVersion": { + "description": "API version used to start the operation.", + "type": "string" + }, + "cancelRequested": { + "description": "Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", + "type": "boolean" + }, + "createTime": { + "description": "The time the operation was created.", + "format": "google-datetime", + "type": "string" + }, + "endTime": { + "description": "The time the operation finished running.", + "format": "google-datetime", + "type": "string" + }, + "requestResource": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "The original request that started the operation.", + "type": "object" + }, + "stages": { + "description": "Mechanism for reporting in-progress stages", + "items": { + "$ref": "GoogleCloudFunctionsV2Stage" + }, + "type": "array" + }, + "statusDetail": { + "description": "Human-readable status of the operation, if any.", + "type": "string" + }, + "target": { + "description": "Server-defined resource path for the target of the operation.", + "type": "string" + }, + "verb": { + "description": "Name of the verb executed by the operation.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudFunctionsV2Stage": { + "description": "Each Stage of the deployment process", + "id": "GoogleCloudFunctionsV2Stage", + "properties": { + "message": { + "description": "Message describing the Stage", + "type": "string" + }, + "name": { + "description": "Name of the Stage. This will be unique for each Stage.", + "enum": [ + "NAME_UNSPECIFIED", + "ARTIFACT_REGISTRY", + "BUILD", + "SERVICE", + "TRIGGER", + "SERVICE_ROLLBACK", + "TRIGGER_ROLLBACK" + ], + "enumDescriptions": [ + "Not specified. Invalid name.", + "Artifact Regsitry Stage", + "Build Stage", + "Service Stage", + "Trigger Stage", + "Service Rollback Stage", + "Trigger Rollback Stage" + ], + "type": "string" + }, + "resource": { + "description": "Resource of the Stage", + "type": "string" + }, + "resourceUri": { + "description": "Link to the current Stage resource", + "type": "string" + }, + "state": { + "description": "Current state of the Stage", + "enum": [ + "STATE_UNSPECIFIED", + "NOT_STARTED", + "IN_PROGRESS", + "COMPLETE" + ], + "enumDescriptions": [ + "Not specified. Invalid state.", + "Stage has not started.", + "Stage is in progress.", + "Stage has completed." + ], + "type": "string" + }, + "stateMessages": { + "description": "State messages from the current Stage.", + "items": { + "$ref": "GoogleCloudFunctionsV2StateMessage" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudFunctionsV2StateMessage": { + "description": "Informational messages about the state of the Cloud Function or Operation.", + "id": "GoogleCloudFunctionsV2StateMessage", + "properties": { + "message": { + "description": "The message.", + "type": "string" + }, + "severity": { + "description": "Severity of the state message.", + "enum": [ + "SEVERITY_UNSPECIFIED", + "ERROR", + "WARNING", + "INFO" + ], + "enumDescriptions": [ + "Not specified. Invalid severity.", + "ERROR-level severity.", + "WARNING-level severity.", + "INFO-level severity." + ], + "type": "string" + }, + "type": { + "description": "One-word CamelCase type of the state message.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudFunctionsV2alphaOperationMetadata": { "description": "Represents the metadata of the long-running operation.", "id": "GoogleCloudFunctionsV2alphaOperationMetadata", diff --git a/googleapiclient/discovery_cache/documents/cloudfunctions.v2beta.json b/googleapiclient/discovery_cache/documents/cloudfunctions.v2beta.json index b39d9aa13e8..2bc22b05cd4 100644 --- a/googleapiclient/discovery_cache/documents/cloudfunctions.v2beta.json +++ b/googleapiclient/discovery_cache/documents/cloudfunctions.v2beta.json @@ -571,7 +571,7 @@ } } }, - "revision": "20220622", + "revision": "20220707", "rootUrl": "https://cloudfunctions.googleapis.com/", "schemas": { "AuditConfig": { @@ -904,6 +904,153 @@ }, "type": "object" }, + "GoogleCloudFunctionsV2OperationMetadata": { + "description": "Represents the metadata of the long-running operation.", + "id": "GoogleCloudFunctionsV2OperationMetadata", + "properties": { + "apiVersion": { + "description": "API version used to start the operation.", + "type": "string" + }, + "cancelRequested": { + "description": "Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", + "type": "boolean" + }, + "createTime": { + "description": "The time the operation was created.", + "format": "google-datetime", + "type": "string" + }, + "endTime": { + "description": "The time the operation finished running.", + "format": "google-datetime", + "type": "string" + }, + "requestResource": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "The original request that started the operation.", + "type": "object" + }, + "stages": { + "description": "Mechanism for reporting in-progress stages", + "items": { + "$ref": "GoogleCloudFunctionsV2Stage" + }, + "type": "array" + }, + "statusDetail": { + "description": "Human-readable status of the operation, if any.", + "type": "string" + }, + "target": { + "description": "Server-defined resource path for the target of the operation.", + "type": "string" + }, + "verb": { + "description": "Name of the verb executed by the operation.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudFunctionsV2Stage": { + "description": "Each Stage of the deployment process", + "id": "GoogleCloudFunctionsV2Stage", + "properties": { + "message": { + "description": "Message describing the Stage", + "type": "string" + }, + "name": { + "description": "Name of the Stage. This will be unique for each Stage.", + "enum": [ + "NAME_UNSPECIFIED", + "ARTIFACT_REGISTRY", + "BUILD", + "SERVICE", + "TRIGGER", + "SERVICE_ROLLBACK", + "TRIGGER_ROLLBACK" + ], + "enumDescriptions": [ + "Not specified. Invalid name.", + "Artifact Regsitry Stage", + "Build Stage", + "Service Stage", + "Trigger Stage", + "Service Rollback Stage", + "Trigger Rollback Stage" + ], + "type": "string" + }, + "resource": { + "description": "Resource of the Stage", + "type": "string" + }, + "resourceUri": { + "description": "Link to the current Stage resource", + "type": "string" + }, + "state": { + "description": "Current state of the Stage", + "enum": [ + "STATE_UNSPECIFIED", + "NOT_STARTED", + "IN_PROGRESS", + "COMPLETE" + ], + "enumDescriptions": [ + "Not specified. Invalid state.", + "Stage has not started.", + "Stage is in progress.", + "Stage has completed." + ], + "type": "string" + }, + "stateMessages": { + "description": "State messages from the current Stage.", + "items": { + "$ref": "GoogleCloudFunctionsV2StateMessage" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudFunctionsV2StateMessage": { + "description": "Informational messages about the state of the Cloud Function or Operation.", + "id": "GoogleCloudFunctionsV2StateMessage", + "properties": { + "message": { + "description": "The message.", + "type": "string" + }, + "severity": { + "description": "Severity of the state message.", + "enum": [ + "SEVERITY_UNSPECIFIED", + "ERROR", + "WARNING", + "INFO" + ], + "enumDescriptions": [ + "Not specified. Invalid severity.", + "ERROR-level severity.", + "WARNING-level severity.", + "INFO-level severity." + ], + "type": "string" + }, + "type": { + "description": "One-word CamelCase type of the state message.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudFunctionsV2alphaOperationMetadata": { "description": "Represents the metadata of the long-running operation.", "id": "GoogleCloudFunctionsV2alphaOperationMetadata", From d4ea38ae66a3e3ae47ec93f25053a036dc65d113 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 19 Jul 2022 07:08:10 +0000 Subject: [PATCH 07/23] feat(cloudsearch): update the api #### cloudsearch:v1 The following keys were added: - schemas.ObjectOptions.properties.suggestionFilteringOperators (Total Keys: 2) --- docs/dyn/cloudsearch_v1.indexing.datasources.html | 6 ++++++ .../discovery_cache/documents/cloudsearch.v1.json | 9 ++++++++- 2 files changed, 14 insertions(+), 1 deletion(-) diff --git a/docs/dyn/cloudsearch_v1.indexing.datasources.html b/docs/dyn/cloudsearch_v1.indexing.datasources.html index 85cc66327f6..217a1376fe4 100644 --- a/docs/dyn/cloudsearch_v1.indexing.datasources.html +++ b/docs/dyn/cloudsearch_v1.indexing.datasources.html @@ -169,6 +169,9 @@

Method Details

"freshnessDuration": "A String", # The duration after which an object should be considered stale. The default value is 180 days (in seconds). "freshnessProperty": "A String", # This property indicates the freshness level of the object in the index. If set, this property must be a top-level property within the property definitions and it must be a timestamp type or date type. Otherwise, the Indexing API uses updateTime as the freshness indicator. The maximum length is 256 characters. When a property is used to calculate freshness, the value defaults to 2 years from the current time. }, + "suggestionFilteringOperators": [ # Operators that can be used to filter suggestions. For Suggest API, only operators mentioned here will be honored in the FilterOptions. Only TEXT and ENUM operators are supported. NOTE: "objecttype", "type" and "mimetype" are already supported. This property is to configure schema specific operators. Even though this is an array, only one operator can be specified. This is an array for future extensibility. Operators mapping to multiple properties within the same object are not supported. If the operator spans across different object types, this option has to be set once for each object definition. + "A String", + ], }, "propertyDefinitions": [ # The property definitions for the object. The maximum number of elements is 1000. { # The definition of a property within an object. @@ -294,6 +297,9 @@

Method Details

"freshnessDuration": "A String", # The duration after which an object should be considered stale. The default value is 180 days (in seconds). "freshnessProperty": "A String", # This property indicates the freshness level of the object in the index. If set, this property must be a top-level property within the property definitions and it must be a timestamp type or date type. Otherwise, the Indexing API uses updateTime as the freshness indicator. The maximum length is 256 characters. When a property is used to calculate freshness, the value defaults to 2 years from the current time. }, + "suggestionFilteringOperators": [ # Operators that can be used to filter suggestions. For Suggest API, only operators mentioned here will be honored in the FilterOptions. Only TEXT and ENUM operators are supported. NOTE: "objecttype", "type" and "mimetype" are already supported. This property is to configure schema specific operators. Even though this is an array, only one operator can be specified. This is an array for future extensibility. Operators mapping to multiple properties within the same object are not supported. If the operator spans across different object types, this option has to be set once for each object definition. + "A String", + ], }, "propertyDefinitions": [ # The property definitions for the object. The maximum number of elements is 1000. { # The definition of a property within an object. diff --git a/googleapiclient/discovery_cache/documents/cloudsearch.v1.json b/googleapiclient/discovery_cache/documents/cloudsearch.v1.json index 4805d04b195..b86916914aa 100644 --- a/googleapiclient/discovery_cache/documents/cloudsearch.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudsearch.v1.json @@ -1994,7 +1994,7 @@ } } }, - "revision": "20220627", + "revision": "20220703", "rootUrl": "https://cloudsearch.googleapis.com/", "schemas": { "AclInfo": { @@ -4149,6 +4149,13 @@ "freshnessOptions": { "$ref": "FreshnessOptions", "description": "The freshness options for an object." + }, + "suggestionFilteringOperators": { + "description": "Operators that can be used to filter suggestions. For Suggest API, only operators mentioned here will be honored in the FilterOptions. Only TEXT and ENUM operators are supported. NOTE: \"objecttype\", \"type\" and \"mimetype\" are already supported. This property is to configure schema specific operators. Even though this is an array, only one operator can be specified. This is an array for future extensibility. Operators mapping to multiple properties within the same object are not supported. If the operator spans across different object types, this option has to be set once for each object definition.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" From 785511348f6ee00cc0b67c230c258067df4c65ef Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 19 Jul 2022 07:08:11 +0000 Subject: [PATCH 08/23] feat(cloudtasks): update the api #### cloudtasks:v2beta2 The following keys were added: - resources.projects.resources.locations.resources.queues.methods.buffer (Total Keys: 12) - schemas.BufferQueueRequest (Total Keys: 3) - schemas.BufferQueueResponse (Total Keys: 3) - schemas.Header (Total Keys: 9) - schemas.HttpBody (Total Keys: 8) - schemas.HttpRequest (Total Keys: 9) - schemas.HttpTarget (Total Keys: 8) - schemas.OAuthToken (Total Keys: 4) - schemas.OidcToken (Total Keys: 4) - schemas.Queue.properties.httpTarget.$ref (Total Keys: 1) - schemas.Task.properties.httpRequest.$ref (Total Keys: 1) - schemas.UriOverride (Total Keys: 8) --- ...sks_v2beta2.projects.locations.queues.html | 271 +++++++++++++++++ ...beta2.projects.locations.queues.tasks.html | 128 ++++++++ .../documents/cloudtasks.v2.json | 2 +- .../documents/cloudtasks.v2beta2.json | 278 +++++++++++++++++- .../documents/cloudtasks.v2beta3.json | 2 +- 5 files changed, 678 insertions(+), 3 deletions(-) diff --git a/docs/dyn/cloudtasks_v2beta2.projects.locations.queues.html b/docs/dyn/cloudtasks_v2beta2.projects.locations.queues.html index 38176dcb74e..1d1b114587f 100644 --- a/docs/dyn/cloudtasks_v2beta2.projects.locations.queues.html +++ b/docs/dyn/cloudtasks_v2beta2.projects.locations.queues.html @@ -79,6 +79,9 @@

Instance Methods

Returns the tasks Resource.

+

+ buffer(name, body=None, x__xgafv=None)

+

Creates and buffers a new task without the need to explicitly define a Task message. The queue must be an http queue (i.e., must have HTTP target). This method is used for a simplified application of Cloud Tasks queues in buffer and rate limitting HTTP requests.

close()

Close httplib2 connections.

@@ -119,6 +122,40 @@

Instance Methods

testIamPermissions(resource, body=None, x__xgafv=None)

Returns permissions that a caller has on a Queue. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Method Details

+
+ buffer(name, body=None, x__xgafv=None) +
Creates and buffers a new task without the need to explicitly define a Task message. The queue must be an http queue (i.e., must have HTTP target). This method is used for a simplified application of Cloud Tasks queues in buffer and rate limitting HTTP requests.
+
+Args:
+  name: string, Required. The queue name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` The queue must already exist. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for BufferQueue.
+  "body": { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged. # Body of the HTTP request. The body can take any generic value. The value will be written to the HttpRequest of the [Task].
+    "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+    "data": "A String", # The HTTP request/response body as raw binary.
+    "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for BufferQueue.
+  "task": "A String", # The name of the created task. For example: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`. TASK_ID is randomly generated and is unique within the queue.
+}
+
+
close()
Close httplib2 connections.
@@ -142,6 +179,32 @@

Method Details

"version": "A String", # App version. By default, the task is sent to the version which is the default version when the task is attempted. For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string. }, }, + "httpTarget": { # HTTP target. When specified as a Queue, all the tasks with [HttpRequest] will be overridden according to the target. # An http_target is used to override the target values for HTTP tasks. + "headerOverrides": [ # HTTP target headers. This map contains the header field names and values. Headers will be set when running the task is created and/or task is created. These headers represent a subset of the headers that will accompany the task's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is: * Any header that is prefixed with "X-Google-Cloud-Tasks-" will be treated as service header. Service headers define properties of the task and are predefined in CloudTask. * Host: This will be computed by Cloud Tasks and derived from HttpRequest.url. * Content-Length: This will be computed by Cloud Tasks. * User-Agent: This will be set to `"Google-Cloud-Tasks"`. * `X-Google-*`: Google use only. * `X-AppEngine-*`: Google use only. `Content-Type` won't be set by Cloud Tasks. You can explicitly set `Content-Type` to a media type when the task is created. For example, `Content-Type` can be set to `"application/octet-stream"` or `"application/json"`. Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values. The size of the headers must be less than 80KB. Queue-level headers to override headers of all the tasks in the queue. + { # Wraps the Header object. + "header": { # Defines a header message. A header can have a key and a value. # header embodying a key and a value. + "key": "A String", + "value": "A String", + }, + }, + ], + "httpMethod": "A String", # The HTTP method to use for the request. When specified, it will override HttpRequest for the task. Note that if the value is set to HttpMethod the HttpRequest of the task will be ignored at execution time. + "oauthToken": { # Contains information needed for generating an [OAuth token](https://developers.google.com/identity/protocols/OAuth2). This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. # If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. + "scope": "A String", # OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used. + "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OAuth token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account. + }, + "oidcToken": { # Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect). This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. # If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) token will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. + "audience": "A String", # Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used. + "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OIDC token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account. + }, + "uriOverride": { # Uri Override. When specified, all the HTTP tasks inside the queue will be partially or fully overridden depending on the configured values. # Uri override. When specified modifies the execution Uri for all the tasks in the queue. + "host": "A String", # Host override. When specified, the host part of url will be overridden. For example, if the original Uri is "https://www.google.com", and host is set to "example.net", the overridden Uri will be "https://example.net". + "path": "A String", # Uri path. Will be used as the path for the current Uri (replaces any existing path of the task url). + "port": "A String", # Port override. When specified, the port part of Uri will be replaced by the provided value. For instance, for a Uri http://www.google.com/foo and port=123 the overridden Uri becomes http://www.google.com:123/foo. + "query": "A String", # Uri Query. Will replace the query part of the task uri. + "scheme": "A String", # Scheme override. When specified, the Uri scheme is replaced by the provided value. + }, + }, "name": "A String", # Caller-specified and required in CreateQueue, after which it becomes output only. The queue name. The queue name must have the following format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the queue's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or hyphens (-). The maximum length is 100 characters. "pullTarget": { # Pull target. # Pull target. A pull queue is a queue that has a PullTarget. }, @@ -188,6 +251,32 @@

Method Details

"version": "A String", # App version. By default, the task is sent to the version which is the default version when the task is attempted. For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string. }, }, + "httpTarget": { # HTTP target. When specified as a Queue, all the tasks with [HttpRequest] will be overridden according to the target. # An http_target is used to override the target values for HTTP tasks. + "headerOverrides": [ # HTTP target headers. This map contains the header field names and values. Headers will be set when running the task is created and/or task is created. These headers represent a subset of the headers that will accompany the task's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is: * Any header that is prefixed with "X-Google-Cloud-Tasks-" will be treated as service header. Service headers define properties of the task and are predefined in CloudTask. * Host: This will be computed by Cloud Tasks and derived from HttpRequest.url. * Content-Length: This will be computed by Cloud Tasks. * User-Agent: This will be set to `"Google-Cloud-Tasks"`. * `X-Google-*`: Google use only. * `X-AppEngine-*`: Google use only. `Content-Type` won't be set by Cloud Tasks. You can explicitly set `Content-Type` to a media type when the task is created. For example, `Content-Type` can be set to `"application/octet-stream"` or `"application/json"`. Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values. The size of the headers must be less than 80KB. Queue-level headers to override headers of all the tasks in the queue. + { # Wraps the Header object. + "header": { # Defines a header message. A header can have a key and a value. # header embodying a key and a value. + "key": "A String", + "value": "A String", + }, + }, + ], + "httpMethod": "A String", # The HTTP method to use for the request. When specified, it will override HttpRequest for the task. Note that if the value is set to HttpMethod the HttpRequest of the task will be ignored at execution time. + "oauthToken": { # Contains information needed for generating an [OAuth token](https://developers.google.com/identity/protocols/OAuth2). This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. # If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. + "scope": "A String", # OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used. + "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OAuth token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account. + }, + "oidcToken": { # Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect). This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. # If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) token will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. + "audience": "A String", # Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used. + "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OIDC token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account. + }, + "uriOverride": { # Uri Override. When specified, all the HTTP tasks inside the queue will be partially or fully overridden depending on the configured values. # Uri override. When specified modifies the execution Uri for all the tasks in the queue. + "host": "A String", # Host override. When specified, the host part of url will be overridden. For example, if the original Uri is "https://www.google.com", and host is set to "example.net", the overridden Uri will be "https://example.net". + "path": "A String", # Uri path. Will be used as the path for the current Uri (replaces any existing path of the task url). + "port": "A String", # Port override. When specified, the port part of Uri will be replaced by the provided value. For instance, for a Uri http://www.google.com/foo and port=123 the overridden Uri becomes http://www.google.com:123/foo. + "query": "A String", # Uri Query. Will replace the query part of the task uri. + "scheme": "A String", # Scheme override. When specified, the Uri scheme is replaced by the provided value. + }, + }, "name": "A String", # Caller-specified and required in CreateQueue, after which it becomes output only. The queue name. The queue name must have the following format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the queue's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or hyphens (-). The maximum length is 100 characters. "pullTarget": { # Pull target. # Pull target. A pull queue is a queue that has a PullTarget. }, @@ -260,6 +349,32 @@

Method Details

"version": "A String", # App version. By default, the task is sent to the version which is the default version when the task is attempted. For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string. }, }, + "httpTarget": { # HTTP target. When specified as a Queue, all the tasks with [HttpRequest] will be overridden according to the target. # An http_target is used to override the target values for HTTP tasks. + "headerOverrides": [ # HTTP target headers. This map contains the header field names and values. Headers will be set when running the task is created and/or task is created. These headers represent a subset of the headers that will accompany the task's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is: * Any header that is prefixed with "X-Google-Cloud-Tasks-" will be treated as service header. Service headers define properties of the task and are predefined in CloudTask. * Host: This will be computed by Cloud Tasks and derived from HttpRequest.url. * Content-Length: This will be computed by Cloud Tasks. * User-Agent: This will be set to `"Google-Cloud-Tasks"`. * `X-Google-*`: Google use only. * `X-AppEngine-*`: Google use only. `Content-Type` won't be set by Cloud Tasks. You can explicitly set `Content-Type` to a media type when the task is created. For example, `Content-Type` can be set to `"application/octet-stream"` or `"application/json"`. Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values. The size of the headers must be less than 80KB. Queue-level headers to override headers of all the tasks in the queue. + { # Wraps the Header object. + "header": { # Defines a header message. A header can have a key and a value. # header embodying a key and a value. + "key": "A String", + "value": "A String", + }, + }, + ], + "httpMethod": "A String", # The HTTP method to use for the request. When specified, it will override HttpRequest for the task. Note that if the value is set to HttpMethod the HttpRequest of the task will be ignored at execution time. + "oauthToken": { # Contains information needed for generating an [OAuth token](https://developers.google.com/identity/protocols/OAuth2). This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. # If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. + "scope": "A String", # OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used. + "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OAuth token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account. + }, + "oidcToken": { # Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect). This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. # If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) token will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. + "audience": "A String", # Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used. + "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OIDC token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account. + }, + "uriOverride": { # Uri Override. When specified, all the HTTP tasks inside the queue will be partially or fully overridden depending on the configured values. # Uri override. When specified modifies the execution Uri for all the tasks in the queue. + "host": "A String", # Host override. When specified, the host part of url will be overridden. For example, if the original Uri is "https://www.google.com", and host is set to "example.net", the overridden Uri will be "https://example.net". + "path": "A String", # Uri path. Will be used as the path for the current Uri (replaces any existing path of the task url). + "port": "A String", # Port override. When specified, the port part of Uri will be replaced by the provided value. For instance, for a Uri http://www.google.com/foo and port=123 the overridden Uri becomes http://www.google.com:123/foo. + "query": "A String", # Uri Query. Will replace the query part of the task uri. + "scheme": "A String", # Scheme override. When specified, the Uri scheme is replaced by the provided value. + }, + }, "name": "A String", # Caller-specified and required in CreateQueue, after which it becomes output only. The queue name. The queue name must have the following format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the queue's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or hyphens (-). The maximum length is 100 characters. "pullTarget": { # Pull target. # Pull target. A pull queue is a queue that has a PullTarget. }, @@ -363,6 +478,32 @@

Method Details

"version": "A String", # App version. By default, the task is sent to the version which is the default version when the task is attempted. For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string. }, }, + "httpTarget": { # HTTP target. When specified as a Queue, all the tasks with [HttpRequest] will be overridden according to the target. # An http_target is used to override the target values for HTTP tasks. + "headerOverrides": [ # HTTP target headers. This map contains the header field names and values. Headers will be set when running the task is created and/or task is created. These headers represent a subset of the headers that will accompany the task's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is: * Any header that is prefixed with "X-Google-Cloud-Tasks-" will be treated as service header. Service headers define properties of the task and are predefined in CloudTask. * Host: This will be computed by Cloud Tasks and derived from HttpRequest.url. * Content-Length: This will be computed by Cloud Tasks. * User-Agent: This will be set to `"Google-Cloud-Tasks"`. * `X-Google-*`: Google use only. * `X-AppEngine-*`: Google use only. `Content-Type` won't be set by Cloud Tasks. You can explicitly set `Content-Type` to a media type when the task is created. For example, `Content-Type` can be set to `"application/octet-stream"` or `"application/json"`. Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values. The size of the headers must be less than 80KB. Queue-level headers to override headers of all the tasks in the queue. + { # Wraps the Header object. + "header": { # Defines a header message. A header can have a key and a value. # header embodying a key and a value. + "key": "A String", + "value": "A String", + }, + }, + ], + "httpMethod": "A String", # The HTTP method to use for the request. When specified, it will override HttpRequest for the task. Note that if the value is set to HttpMethod the HttpRequest of the task will be ignored at execution time. + "oauthToken": { # Contains information needed for generating an [OAuth token](https://developers.google.com/identity/protocols/OAuth2). This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. # If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. + "scope": "A String", # OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used. + "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OAuth token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account. + }, + "oidcToken": { # Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect). This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. # If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) token will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. + "audience": "A String", # Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used. + "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OIDC token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account. + }, + "uriOverride": { # Uri Override. When specified, all the HTTP tasks inside the queue will be partially or fully overridden depending on the configured values. # Uri override. When specified modifies the execution Uri for all the tasks in the queue. + "host": "A String", # Host override. When specified, the host part of url will be overridden. For example, if the original Uri is "https://www.google.com", and host is set to "example.net", the overridden Uri will be "https://example.net". + "path": "A String", # Uri path. Will be used as the path for the current Uri (replaces any existing path of the task url). + "port": "A String", # Port override. When specified, the port part of Uri will be replaced by the provided value. For instance, for a Uri http://www.google.com/foo and port=123 the overridden Uri becomes http://www.google.com:123/foo. + "query": "A String", # Uri Query. Will replace the query part of the task uri. + "scheme": "A String", # Scheme override. When specified, the Uri scheme is replaced by the provided value. + }, + }, "name": "A String", # Caller-specified and required in CreateQueue, after which it becomes output only. The queue name. The queue name must have the following format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the queue's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or hyphens (-). The maximum length is 100 characters. "pullTarget": { # Pull target. # Pull target. A pull queue is a queue that has a PullTarget. }, @@ -427,6 +568,32 @@

Method Details

"version": "A String", # App version. By default, the task is sent to the version which is the default version when the task is attempted. For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string. }, }, + "httpTarget": { # HTTP target. When specified as a Queue, all the tasks with [HttpRequest] will be overridden according to the target. # An http_target is used to override the target values for HTTP tasks. + "headerOverrides": [ # HTTP target headers. This map contains the header field names and values. Headers will be set when running the task is created and/or task is created. These headers represent a subset of the headers that will accompany the task's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is: * Any header that is prefixed with "X-Google-Cloud-Tasks-" will be treated as service header. Service headers define properties of the task and are predefined in CloudTask. * Host: This will be computed by Cloud Tasks and derived from HttpRequest.url. * Content-Length: This will be computed by Cloud Tasks. * User-Agent: This will be set to `"Google-Cloud-Tasks"`. * `X-Google-*`: Google use only. * `X-AppEngine-*`: Google use only. `Content-Type` won't be set by Cloud Tasks. You can explicitly set `Content-Type` to a media type when the task is created. For example, `Content-Type` can be set to `"application/octet-stream"` or `"application/json"`. Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values. The size of the headers must be less than 80KB. Queue-level headers to override headers of all the tasks in the queue. + { # Wraps the Header object. + "header": { # Defines a header message. A header can have a key and a value. # header embodying a key and a value. + "key": "A String", + "value": "A String", + }, + }, + ], + "httpMethod": "A String", # The HTTP method to use for the request. When specified, it will override HttpRequest for the task. Note that if the value is set to HttpMethod the HttpRequest of the task will be ignored at execution time. + "oauthToken": { # Contains information needed for generating an [OAuth token](https://developers.google.com/identity/protocols/OAuth2). This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. # If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. + "scope": "A String", # OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used. + "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OAuth token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account. + }, + "oidcToken": { # Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect). This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. # If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) token will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. + "audience": "A String", # Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used. + "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OIDC token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account. + }, + "uriOverride": { # Uri Override. When specified, all the HTTP tasks inside the queue will be partially or fully overridden depending on the configured values. # Uri override. When specified modifies the execution Uri for all the tasks in the queue. + "host": "A String", # Host override. When specified, the host part of url will be overridden. For example, if the original Uri is "https://www.google.com", and host is set to "example.net", the overridden Uri will be "https://example.net". + "path": "A String", # Uri path. Will be used as the path for the current Uri (replaces any existing path of the task url). + "port": "A String", # Port override. When specified, the port part of Uri will be replaced by the provided value. For instance, for a Uri http://www.google.com/foo and port=123 the overridden Uri becomes http://www.google.com:123/foo. + "query": "A String", # Uri Query. Will replace the query part of the task uri. + "scheme": "A String", # Scheme override. When specified, the Uri scheme is replaced by the provided value. + }, + }, "name": "A String", # Caller-specified and required in CreateQueue, after which it becomes output only. The queue name. The queue name must have the following format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the queue's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or hyphens (-). The maximum length is 100 characters. "pullTarget": { # Pull target. # Pull target. A pull queue is a queue that has a PullTarget. }, @@ -474,6 +641,32 @@

Method Details

"version": "A String", # App version. By default, the task is sent to the version which is the default version when the task is attempted. For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string. }, }, + "httpTarget": { # HTTP target. When specified as a Queue, all the tasks with [HttpRequest] will be overridden according to the target. # An http_target is used to override the target values for HTTP tasks. + "headerOverrides": [ # HTTP target headers. This map contains the header field names and values. Headers will be set when running the task is created and/or task is created. These headers represent a subset of the headers that will accompany the task's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is: * Any header that is prefixed with "X-Google-Cloud-Tasks-" will be treated as service header. Service headers define properties of the task and are predefined in CloudTask. * Host: This will be computed by Cloud Tasks and derived from HttpRequest.url. * Content-Length: This will be computed by Cloud Tasks. * User-Agent: This will be set to `"Google-Cloud-Tasks"`. * `X-Google-*`: Google use only. * `X-AppEngine-*`: Google use only. `Content-Type` won't be set by Cloud Tasks. You can explicitly set `Content-Type` to a media type when the task is created. For example, `Content-Type` can be set to `"application/octet-stream"` or `"application/json"`. Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values. The size of the headers must be less than 80KB. Queue-level headers to override headers of all the tasks in the queue. + { # Wraps the Header object. + "header": { # Defines a header message. A header can have a key and a value. # header embodying a key and a value. + "key": "A String", + "value": "A String", + }, + }, + ], + "httpMethod": "A String", # The HTTP method to use for the request. When specified, it will override HttpRequest for the task. Note that if the value is set to HttpMethod the HttpRequest of the task will be ignored at execution time. + "oauthToken": { # Contains information needed for generating an [OAuth token](https://developers.google.com/identity/protocols/OAuth2). This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. # If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. + "scope": "A String", # OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used. + "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OAuth token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account. + }, + "oidcToken": { # Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect). This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. # If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) token will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. + "audience": "A String", # Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used. + "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OIDC token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account. + }, + "uriOverride": { # Uri Override. When specified, all the HTTP tasks inside the queue will be partially or fully overridden depending on the configured values. # Uri override. When specified modifies the execution Uri for all the tasks in the queue. + "host": "A String", # Host override. When specified, the host part of url will be overridden. For example, if the original Uri is "https://www.google.com", and host is set to "example.net", the overridden Uri will be "https://example.net". + "path": "A String", # Uri path. Will be used as the path for the current Uri (replaces any existing path of the task url). + "port": "A String", # Port override. When specified, the port part of Uri will be replaced by the provided value. For instance, for a Uri http://www.google.com/foo and port=123 the overridden Uri becomes http://www.google.com:123/foo. + "query": "A String", # Uri Query. Will replace the query part of the task uri. + "scheme": "A String", # Scheme override. When specified, the Uri scheme is replaced by the provided value. + }, + }, "name": "A String", # Caller-specified and required in CreateQueue, after which it becomes output only. The queue name. The queue name must have the following format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the queue's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or hyphens (-). The maximum length is 100 characters. "pullTarget": { # Pull target. # Pull target. A pull queue is a queue that has a PullTarget. }, @@ -533,6 +726,32 @@

Method Details

"version": "A String", # App version. By default, the task is sent to the version which is the default version when the task is attempted. For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string. }, }, + "httpTarget": { # HTTP target. When specified as a Queue, all the tasks with [HttpRequest] will be overridden according to the target. # An http_target is used to override the target values for HTTP tasks. + "headerOverrides": [ # HTTP target headers. This map contains the header field names and values. Headers will be set when running the task is created and/or task is created. These headers represent a subset of the headers that will accompany the task's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is: * Any header that is prefixed with "X-Google-Cloud-Tasks-" will be treated as service header. Service headers define properties of the task and are predefined in CloudTask. * Host: This will be computed by Cloud Tasks and derived from HttpRequest.url. * Content-Length: This will be computed by Cloud Tasks. * User-Agent: This will be set to `"Google-Cloud-Tasks"`. * `X-Google-*`: Google use only. * `X-AppEngine-*`: Google use only. `Content-Type` won't be set by Cloud Tasks. You can explicitly set `Content-Type` to a media type when the task is created. For example, `Content-Type` can be set to `"application/octet-stream"` or `"application/json"`. Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values. The size of the headers must be less than 80KB. Queue-level headers to override headers of all the tasks in the queue. + { # Wraps the Header object. + "header": { # Defines a header message. A header can have a key and a value. # header embodying a key and a value. + "key": "A String", + "value": "A String", + }, + }, + ], + "httpMethod": "A String", # The HTTP method to use for the request. When specified, it will override HttpRequest for the task. Note that if the value is set to HttpMethod the HttpRequest of the task will be ignored at execution time. + "oauthToken": { # Contains information needed for generating an [OAuth token](https://developers.google.com/identity/protocols/OAuth2). This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. # If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. + "scope": "A String", # OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used. + "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OAuth token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account. + }, + "oidcToken": { # Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect). This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. # If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) token will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. + "audience": "A String", # Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used. + "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OIDC token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account. + }, + "uriOverride": { # Uri Override. When specified, all the HTTP tasks inside the queue will be partially or fully overridden depending on the configured values. # Uri override. When specified modifies the execution Uri for all the tasks in the queue. + "host": "A String", # Host override. When specified, the host part of url will be overridden. For example, if the original Uri is "https://www.google.com", and host is set to "example.net", the overridden Uri will be "https://example.net". + "path": "A String", # Uri path. Will be used as the path for the current Uri (replaces any existing path of the task url). + "port": "A String", # Port override. When specified, the port part of Uri will be replaced by the provided value. For instance, for a Uri http://www.google.com/foo and port=123 the overridden Uri becomes http://www.google.com:123/foo. + "query": "A String", # Uri Query. Will replace the query part of the task uri. + "scheme": "A String", # Scheme override. When specified, the Uri scheme is replaced by the provided value. + }, + }, "name": "A String", # Caller-specified and required in CreateQueue, after which it becomes output only. The queue name. The queue name must have the following format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the queue's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or hyphens (-). The maximum length is 100 characters. "pullTarget": { # Pull target. # Pull target. A pull queue is a queue that has a PullTarget. }, @@ -592,6 +811,32 @@

Method Details

"version": "A String", # App version. By default, the task is sent to the version which is the default version when the task is attempted. For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string. }, }, + "httpTarget": { # HTTP target. When specified as a Queue, all the tasks with [HttpRequest] will be overridden according to the target. # An http_target is used to override the target values for HTTP tasks. + "headerOverrides": [ # HTTP target headers. This map contains the header field names and values. Headers will be set when running the task is created and/or task is created. These headers represent a subset of the headers that will accompany the task's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is: * Any header that is prefixed with "X-Google-Cloud-Tasks-" will be treated as service header. Service headers define properties of the task and are predefined in CloudTask. * Host: This will be computed by Cloud Tasks and derived from HttpRequest.url. * Content-Length: This will be computed by Cloud Tasks. * User-Agent: This will be set to `"Google-Cloud-Tasks"`. * `X-Google-*`: Google use only. * `X-AppEngine-*`: Google use only. `Content-Type` won't be set by Cloud Tasks. You can explicitly set `Content-Type` to a media type when the task is created. For example, `Content-Type` can be set to `"application/octet-stream"` or `"application/json"`. Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values. The size of the headers must be less than 80KB. Queue-level headers to override headers of all the tasks in the queue. + { # Wraps the Header object. + "header": { # Defines a header message. A header can have a key and a value. # header embodying a key and a value. + "key": "A String", + "value": "A String", + }, + }, + ], + "httpMethod": "A String", # The HTTP method to use for the request. When specified, it will override HttpRequest for the task. Note that if the value is set to HttpMethod the HttpRequest of the task will be ignored at execution time. + "oauthToken": { # Contains information needed for generating an [OAuth token](https://developers.google.com/identity/protocols/OAuth2). This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. # If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. + "scope": "A String", # OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used. + "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OAuth token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account. + }, + "oidcToken": { # Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect). This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. # If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) token will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. + "audience": "A String", # Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used. + "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OIDC token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account. + }, + "uriOverride": { # Uri Override. When specified, all the HTTP tasks inside the queue will be partially or fully overridden depending on the configured values. # Uri override. When specified modifies the execution Uri for all the tasks in the queue. + "host": "A String", # Host override. When specified, the host part of url will be overridden. For example, if the original Uri is "https://www.google.com", and host is set to "example.net", the overridden Uri will be "https://example.net". + "path": "A String", # Uri path. Will be used as the path for the current Uri (replaces any existing path of the task url). + "port": "A String", # Port override. When specified, the port part of Uri will be replaced by the provided value. For instance, for a Uri http://www.google.com/foo and port=123 the overridden Uri becomes http://www.google.com:123/foo. + "query": "A String", # Uri Query. Will replace the query part of the task uri. + "scheme": "A String", # Scheme override. When specified, the Uri scheme is replaced by the provided value. + }, + }, "name": "A String", # Caller-specified and required in CreateQueue, after which it becomes output only. The queue name. The queue name must have the following format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the queue's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or hyphens (-). The maximum length is 100 characters. "pullTarget": { # Pull target. # Pull target. A pull queue is a queue that has a PullTarget. }, @@ -651,6 +896,32 @@

Method Details

"version": "A String", # App version. By default, the task is sent to the version which is the default version when the task is attempted. For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string. }, }, + "httpTarget": { # HTTP target. When specified as a Queue, all the tasks with [HttpRequest] will be overridden according to the target. # An http_target is used to override the target values for HTTP tasks. + "headerOverrides": [ # HTTP target headers. This map contains the header field names and values. Headers will be set when running the task is created and/or task is created. These headers represent a subset of the headers that will accompany the task's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is: * Any header that is prefixed with "X-Google-Cloud-Tasks-" will be treated as service header. Service headers define properties of the task and are predefined in CloudTask. * Host: This will be computed by Cloud Tasks and derived from HttpRequest.url. * Content-Length: This will be computed by Cloud Tasks. * User-Agent: This will be set to `"Google-Cloud-Tasks"`. * `X-Google-*`: Google use only. * `X-AppEngine-*`: Google use only. `Content-Type` won't be set by Cloud Tasks. You can explicitly set `Content-Type` to a media type when the task is created. For example, `Content-Type` can be set to `"application/octet-stream"` or `"application/json"`. Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values. The size of the headers must be less than 80KB. Queue-level headers to override headers of all the tasks in the queue. + { # Wraps the Header object. + "header": { # Defines a header message. A header can have a key and a value. # header embodying a key and a value. + "key": "A String", + "value": "A String", + }, + }, + ], + "httpMethod": "A String", # The HTTP method to use for the request. When specified, it will override HttpRequest for the task. Note that if the value is set to HttpMethod the HttpRequest of the task will be ignored at execution time. + "oauthToken": { # Contains information needed for generating an [OAuth token](https://developers.google.com/identity/protocols/OAuth2). This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. # If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. + "scope": "A String", # OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used. + "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OAuth token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account. + }, + "oidcToken": { # Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect). This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. # If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) token will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. + "audience": "A String", # Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used. + "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OIDC token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account. + }, + "uriOverride": { # Uri Override. When specified, all the HTTP tasks inside the queue will be partially or fully overridden depending on the configured values. # Uri override. When specified modifies the execution Uri for all the tasks in the queue. + "host": "A String", # Host override. When specified, the host part of url will be overridden. For example, if the original Uri is "https://www.google.com", and host is set to "example.net", the overridden Uri will be "https://example.net". + "path": "A String", # Uri path. Will be used as the path for the current Uri (replaces any existing path of the task url). + "port": "A String", # Port override. When specified, the port part of Uri will be replaced by the provided value. For instance, for a Uri http://www.google.com/foo and port=123 the overridden Uri becomes http://www.google.com:123/foo. + "query": "A String", # Uri Query. Will replace the query part of the task uri. + "scheme": "A String", # Scheme override. When specified, the Uri scheme is replaced by the provided value. + }, + }, "name": "A String", # Caller-specified and required in CreateQueue, after which it becomes output only. The queue name. The queue name must have the following format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the queue's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or hyphens (-). The maximum length is 100 characters. "pullTarget": { # Pull target. # Pull target. A pull queue is a queue that has a PullTarget. }, diff --git a/docs/dyn/cloudtasks_v2beta2.projects.locations.queues.tasks.html b/docs/dyn/cloudtasks_v2beta2.projects.locations.queues.tasks.html index 2192cda80fb..2da5ec74168 100644 --- a/docs/dyn/cloudtasks_v2beta2.projects.locations.queues.tasks.html +++ b/docs/dyn/cloudtasks_v2beta2.projects.locations.queues.tasks.html @@ -171,6 +171,22 @@

Method Details

"relativeUrl": "A String", # The relative URL. The relative URL must begin with "/" and must be a valid HTTP relative URL. It can contain a path and query string arguments. If the relative URL is empty, then the root path "/" will be used. No spaces are allowed, and the maximum length allowed is 2083 characters. }, "createTime": "A String", # Output only. The time that the task was created. `create_time` will be truncated to the nearest second. + "httpRequest": { # HTTP request. The task will be pushed to the worker as an HTTP request. An HTTP request embodies a url, an http method, headers, body and authorization for the http task. # HTTP request that is sent to the task's target. An HTTP task is a task that has HttpRequest set. + "body": "A String", # HTTP request body. A request body is allowed only if the HTTP method is POST, PUT, or PATCH. It is an error to set body on a task with an incompatible HttpMethod. + "headers": { # HTTP request headers. This map contains the header field names and values. Headers can be set when running the task is created or task is created. These headers represent a subset of the headers that will accompany the task's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is: * Any header that is prefixed with "X-Google-Cloud-Tasks-" will be treated as service header. Service headers define properties of the task and are predefined in CloudTask. * Host: This will be computed by Cloud Tasks and derived from HttpRequest.url. * Content-Length: This will be computed by Cloud Tasks. * User-Agent: This will be set to `"Google-Cloud-Tasks"`. * `X-Google-*`: Google use only. * `X-AppEngine-*`: Google use only. `Content-Type` won't be set by Cloud Tasks. You can explicitly set `Content-Type` to a media type when the task is created. For example, `Content-Type` can be set to `"application/octet-stream"` or `"application/json"`. Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values. The size of the headers must be less than 80KB. + "a_key": "A String", + }, + "httpMethod": "A String", # The HTTP method to use for the request. The default is POST. + "oauthToken": { # Contains information needed for generating an [OAuth token](https://developers.google.com/identity/protocols/OAuth2). This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. # If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. + "scope": "A String", # OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used. + "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OAuth token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account. + }, + "oidcToken": { # Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect). This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. # If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) token will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. + "audience": "A String", # Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used. + "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OIDC token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account. + }, + "url": "A String", # Required. The full url path that the request will be sent to. This string must begin with either "http://" or "https://". Some examples are: `http://acme.com` and `https://acme.com/sales:8080`. Cloud Tasks will encode some characters for safety and compatibility. The maximum allowed URL length is 2083 characters after encoding. The `Location` header response from a redirect response [`300` - `399`] may be followed. The redirect is not counted as a separate attempt. + }, "name": "A String", # Optionally caller-specified in CreateTask. The task name. The task name must have the following format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the task's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or hyphens (-). The maximum length is 100 characters. * `TASK_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters. "pullMessage": { # The pull message contains data that can be used by the caller of LeaseTasks to process the task. This proto can only be used for tasks in a queue which has pull_target set. # LeaseTasks to process the task. Can be set only if pull_target is set on the queue. A pull task is a task that has PullMessage set. "payload": "A String", # A data payload consumed by the worker to execute the task. @@ -245,6 +261,22 @@

Method Details

"relativeUrl": "A String", # The relative URL. The relative URL must begin with "/" and must be a valid HTTP relative URL. It can contain a path and query string arguments. If the relative URL is empty, then the root path "/" will be used. No spaces are allowed, and the maximum length allowed is 2083 characters. }, "createTime": "A String", # Output only. The time that the task was created. `create_time` will be truncated to the nearest second. + "httpRequest": { # HTTP request. The task will be pushed to the worker as an HTTP request. An HTTP request embodies a url, an http method, headers, body and authorization for the http task. # HTTP request that is sent to the task's target. An HTTP task is a task that has HttpRequest set. + "body": "A String", # HTTP request body. A request body is allowed only if the HTTP method is POST, PUT, or PATCH. It is an error to set body on a task with an incompatible HttpMethod. + "headers": { # HTTP request headers. This map contains the header field names and values. Headers can be set when running the task is created or task is created. These headers represent a subset of the headers that will accompany the task's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is: * Any header that is prefixed with "X-Google-Cloud-Tasks-" will be treated as service header. Service headers define properties of the task and are predefined in CloudTask. * Host: This will be computed by Cloud Tasks and derived from HttpRequest.url. * Content-Length: This will be computed by Cloud Tasks. * User-Agent: This will be set to `"Google-Cloud-Tasks"`. * `X-Google-*`: Google use only. * `X-AppEngine-*`: Google use only. `Content-Type` won't be set by Cloud Tasks. You can explicitly set `Content-Type` to a media type when the task is created. For example, `Content-Type` can be set to `"application/octet-stream"` or `"application/json"`. Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values. The size of the headers must be less than 80KB. + "a_key": "A String", + }, + "httpMethod": "A String", # The HTTP method to use for the request. The default is POST. + "oauthToken": { # Contains information needed for generating an [OAuth token](https://developers.google.com/identity/protocols/OAuth2). This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. # If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. + "scope": "A String", # OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used. + "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OAuth token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account. + }, + "oidcToken": { # Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect). This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. # If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) token will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. + "audience": "A String", # Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used. + "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OIDC token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account. + }, + "url": "A String", # Required. The full url path that the request will be sent to. This string must begin with either "http://" or "https://". Some examples are: `http://acme.com` and `https://acme.com/sales:8080`. Cloud Tasks will encode some characters for safety and compatibility. The maximum allowed URL length is 2083 characters after encoding. The `Location` header response from a redirect response [`300` - `399`] may be followed. The redirect is not counted as a separate attempt. + }, "name": "A String", # Optionally caller-specified in CreateTask. The task name. The task name must have the following format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the task's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or hyphens (-). The maximum length is 100 characters. * `TASK_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters. "pullMessage": { # The pull message contains data that can be used by the caller of LeaseTasks to process the task. This proto can only be used for tasks in a queue which has pull_target set. # LeaseTasks to process the task. Can be set only if pull_target is set on the queue. A pull task is a task that has PullMessage set. "payload": "A String", # A data payload consumed by the worker to execute the task. @@ -311,6 +343,22 @@

Method Details

"relativeUrl": "A String", # The relative URL. The relative URL must begin with "/" and must be a valid HTTP relative URL. It can contain a path and query string arguments. If the relative URL is empty, then the root path "/" will be used. No spaces are allowed, and the maximum length allowed is 2083 characters. }, "createTime": "A String", # Output only. The time that the task was created. `create_time` will be truncated to the nearest second. + "httpRequest": { # HTTP request. The task will be pushed to the worker as an HTTP request. An HTTP request embodies a url, an http method, headers, body and authorization for the http task. # HTTP request that is sent to the task's target. An HTTP task is a task that has HttpRequest set. + "body": "A String", # HTTP request body. A request body is allowed only if the HTTP method is POST, PUT, or PATCH. It is an error to set body on a task with an incompatible HttpMethod. + "headers": { # HTTP request headers. This map contains the header field names and values. Headers can be set when running the task is created or task is created. These headers represent a subset of the headers that will accompany the task's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is: * Any header that is prefixed with "X-Google-Cloud-Tasks-" will be treated as service header. Service headers define properties of the task and are predefined in CloudTask. * Host: This will be computed by Cloud Tasks and derived from HttpRequest.url. * Content-Length: This will be computed by Cloud Tasks. * User-Agent: This will be set to `"Google-Cloud-Tasks"`. * `X-Google-*`: Google use only. * `X-AppEngine-*`: Google use only. `Content-Type` won't be set by Cloud Tasks. You can explicitly set `Content-Type` to a media type when the task is created. For example, `Content-Type` can be set to `"application/octet-stream"` or `"application/json"`. Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values. The size of the headers must be less than 80KB. + "a_key": "A String", + }, + "httpMethod": "A String", # The HTTP method to use for the request. The default is POST. + "oauthToken": { # Contains information needed for generating an [OAuth token](https://developers.google.com/identity/protocols/OAuth2). This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. # If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. + "scope": "A String", # OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used. + "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OAuth token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account. + }, + "oidcToken": { # Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect). This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. # If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) token will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. + "audience": "A String", # Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used. + "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OIDC token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account. + }, + "url": "A String", # Required. The full url path that the request will be sent to. This string must begin with either "http://" or "https://". Some examples are: `http://acme.com` and `https://acme.com/sales:8080`. Cloud Tasks will encode some characters for safety and compatibility. The maximum allowed URL length is 2083 characters after encoding. The `Location` header response from a redirect response [`300` - `399`] may be followed. The redirect is not counted as a separate attempt. + }, "name": "A String", # Optionally caller-specified in CreateTask. The task name. The task name must have the following format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the task's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or hyphens (-). The maximum length is 100 characters. * `TASK_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters. "pullMessage": { # The pull message contains data that can be used by the caller of LeaseTasks to process the task. This proto can only be used for tasks in a queue which has pull_target set. # LeaseTasks to process the task. Can be set only if pull_target is set on the queue. A pull task is a task that has PullMessage set. "payload": "A String", # A data payload consumed by the worker to execute the task. @@ -406,6 +454,22 @@

Method Details

"relativeUrl": "A String", # The relative URL. The relative URL must begin with "/" and must be a valid HTTP relative URL. It can contain a path and query string arguments. If the relative URL is empty, then the root path "/" will be used. No spaces are allowed, and the maximum length allowed is 2083 characters. }, "createTime": "A String", # Output only. The time that the task was created. `create_time` will be truncated to the nearest second. + "httpRequest": { # HTTP request. The task will be pushed to the worker as an HTTP request. An HTTP request embodies a url, an http method, headers, body and authorization for the http task. # HTTP request that is sent to the task's target. An HTTP task is a task that has HttpRequest set. + "body": "A String", # HTTP request body. A request body is allowed only if the HTTP method is POST, PUT, or PATCH. It is an error to set body on a task with an incompatible HttpMethod. + "headers": { # HTTP request headers. This map contains the header field names and values. Headers can be set when running the task is created or task is created. These headers represent a subset of the headers that will accompany the task's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is: * Any header that is prefixed with "X-Google-Cloud-Tasks-" will be treated as service header. Service headers define properties of the task and are predefined in CloudTask. * Host: This will be computed by Cloud Tasks and derived from HttpRequest.url. * Content-Length: This will be computed by Cloud Tasks. * User-Agent: This will be set to `"Google-Cloud-Tasks"`. * `X-Google-*`: Google use only. * `X-AppEngine-*`: Google use only. `Content-Type` won't be set by Cloud Tasks. You can explicitly set `Content-Type` to a media type when the task is created. For example, `Content-Type` can be set to `"application/octet-stream"` or `"application/json"`. Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values. The size of the headers must be less than 80KB. + "a_key": "A String", + }, + "httpMethod": "A String", # The HTTP method to use for the request. The default is POST. + "oauthToken": { # Contains information needed for generating an [OAuth token](https://developers.google.com/identity/protocols/OAuth2). This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. # If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. + "scope": "A String", # OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used. + "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OAuth token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account. + }, + "oidcToken": { # Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect). This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. # If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) token will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. + "audience": "A String", # Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used. + "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OIDC token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account. + }, + "url": "A String", # Required. The full url path that the request will be sent to. This string must begin with either "http://" or "https://". Some examples are: `http://acme.com` and `https://acme.com/sales:8080`. Cloud Tasks will encode some characters for safety and compatibility. The maximum allowed URL length is 2083 characters after encoding. The `Location` header response from a redirect response [`300` - `399`] may be followed. The redirect is not counted as a separate attempt. + }, "name": "A String", # Optionally caller-specified in CreateTask. The task name. The task name must have the following format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the task's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or hyphens (-). The maximum length is 100 characters. * `TASK_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters. "pullMessage": { # The pull message contains data that can be used by the caller of LeaseTasks to process the task. This proto can only be used for tasks in a queue which has pull_target set. # LeaseTasks to process the task. Can be set only if pull_target is set on the queue. A pull task is a task that has PullMessage set. "payload": "A String", # A data payload consumed by the worker to execute the task. @@ -490,6 +554,22 @@

Method Details

"relativeUrl": "A String", # The relative URL. The relative URL must begin with "/" and must be a valid HTTP relative URL. It can contain a path and query string arguments. If the relative URL is empty, then the root path "/" will be used. No spaces are allowed, and the maximum length allowed is 2083 characters. }, "createTime": "A String", # Output only. The time that the task was created. `create_time` will be truncated to the nearest second. + "httpRequest": { # HTTP request. The task will be pushed to the worker as an HTTP request. An HTTP request embodies a url, an http method, headers, body and authorization for the http task. # HTTP request that is sent to the task's target. An HTTP task is a task that has HttpRequest set. + "body": "A String", # HTTP request body. A request body is allowed only if the HTTP method is POST, PUT, or PATCH. It is an error to set body on a task with an incompatible HttpMethod. + "headers": { # HTTP request headers. This map contains the header field names and values. Headers can be set when running the task is created or task is created. These headers represent a subset of the headers that will accompany the task's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is: * Any header that is prefixed with "X-Google-Cloud-Tasks-" will be treated as service header. Service headers define properties of the task and are predefined in CloudTask. * Host: This will be computed by Cloud Tasks and derived from HttpRequest.url. * Content-Length: This will be computed by Cloud Tasks. * User-Agent: This will be set to `"Google-Cloud-Tasks"`. * `X-Google-*`: Google use only. * `X-AppEngine-*`: Google use only. `Content-Type` won't be set by Cloud Tasks. You can explicitly set `Content-Type` to a media type when the task is created. For example, `Content-Type` can be set to `"application/octet-stream"` or `"application/json"`. Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values. The size of the headers must be less than 80KB. + "a_key": "A String", + }, + "httpMethod": "A String", # The HTTP method to use for the request. The default is POST. + "oauthToken": { # Contains information needed for generating an [OAuth token](https://developers.google.com/identity/protocols/OAuth2). This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. # If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. + "scope": "A String", # OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used. + "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OAuth token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account. + }, + "oidcToken": { # Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect). This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. # If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) token will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. + "audience": "A String", # Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used. + "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OIDC token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account. + }, + "url": "A String", # Required. The full url path that the request will be sent to. This string must begin with either "http://" or "https://". Some examples are: `http://acme.com` and `https://acme.com/sales:8080`. Cloud Tasks will encode some characters for safety and compatibility. The maximum allowed URL length is 2083 characters after encoding. The `Location` header response from a redirect response [`300` - `399`] may be followed. The redirect is not counted as a separate attempt. + }, "name": "A String", # Optionally caller-specified in CreateTask. The task name. The task name must have the following format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the task's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or hyphens (-). The maximum length is 100 characters. * `TASK_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters. "pullMessage": { # The pull message contains data that can be used by the caller of LeaseTasks to process the task. This proto can only be used for tasks in a queue which has pull_target set. # LeaseTasks to process the task. Can be set only if pull_target is set on the queue. A pull task is a task that has PullMessage set. "payload": "A String", # A data payload consumed by the worker to execute the task. @@ -574,6 +654,22 @@

Method Details

"relativeUrl": "A String", # The relative URL. The relative URL must begin with "/" and must be a valid HTTP relative URL. It can contain a path and query string arguments. If the relative URL is empty, then the root path "/" will be used. No spaces are allowed, and the maximum length allowed is 2083 characters. }, "createTime": "A String", # Output only. The time that the task was created. `create_time` will be truncated to the nearest second. + "httpRequest": { # HTTP request. The task will be pushed to the worker as an HTTP request. An HTTP request embodies a url, an http method, headers, body and authorization for the http task. # HTTP request that is sent to the task's target. An HTTP task is a task that has HttpRequest set. + "body": "A String", # HTTP request body. A request body is allowed only if the HTTP method is POST, PUT, or PATCH. It is an error to set body on a task with an incompatible HttpMethod. + "headers": { # HTTP request headers. This map contains the header field names and values. Headers can be set when running the task is created or task is created. These headers represent a subset of the headers that will accompany the task's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is: * Any header that is prefixed with "X-Google-Cloud-Tasks-" will be treated as service header. Service headers define properties of the task and are predefined in CloudTask. * Host: This will be computed by Cloud Tasks and derived from HttpRequest.url. * Content-Length: This will be computed by Cloud Tasks. * User-Agent: This will be set to `"Google-Cloud-Tasks"`. * `X-Google-*`: Google use only. * `X-AppEngine-*`: Google use only. `Content-Type` won't be set by Cloud Tasks. You can explicitly set `Content-Type` to a media type when the task is created. For example, `Content-Type` can be set to `"application/octet-stream"` or `"application/json"`. Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values. The size of the headers must be less than 80KB. + "a_key": "A String", + }, + "httpMethod": "A String", # The HTTP method to use for the request. The default is POST. + "oauthToken": { # Contains information needed for generating an [OAuth token](https://developers.google.com/identity/protocols/OAuth2). This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. # If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. + "scope": "A String", # OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used. + "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OAuth token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account. + }, + "oidcToken": { # Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect). This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. # If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) token will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. + "audience": "A String", # Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used. + "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OIDC token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account. + }, + "url": "A String", # Required. The full url path that the request will be sent to. This string must begin with either "http://" or "https://". Some examples are: `http://acme.com` and `https://acme.com/sales:8080`. Cloud Tasks will encode some characters for safety and compatibility. The maximum allowed URL length is 2083 characters after encoding. The `Location` header response from a redirect response [`300` - `399`] may be followed. The redirect is not counted as a separate attempt. + }, "name": "A String", # Optionally caller-specified in CreateTask. The task name. The task name must have the following format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the task's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or hyphens (-). The maximum length is 100 characters. * `TASK_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters. "pullMessage": { # The pull message contains data that can be used by the caller of LeaseTasks to process the task. This proto can only be used for tasks in a queue which has pull_target set. # LeaseTasks to process the task. Can be set only if pull_target is set on the queue. A pull task is a task that has PullMessage set. "payload": "A String", # A data payload consumed by the worker to execute the task. @@ -671,6 +767,22 @@

Method Details

"relativeUrl": "A String", # The relative URL. The relative URL must begin with "/" and must be a valid HTTP relative URL. It can contain a path and query string arguments. If the relative URL is empty, then the root path "/" will be used. No spaces are allowed, and the maximum length allowed is 2083 characters. }, "createTime": "A String", # Output only. The time that the task was created. `create_time` will be truncated to the nearest second. + "httpRequest": { # HTTP request. The task will be pushed to the worker as an HTTP request. An HTTP request embodies a url, an http method, headers, body and authorization for the http task. # HTTP request that is sent to the task's target. An HTTP task is a task that has HttpRequest set. + "body": "A String", # HTTP request body. A request body is allowed only if the HTTP method is POST, PUT, or PATCH. It is an error to set body on a task with an incompatible HttpMethod. + "headers": { # HTTP request headers. This map contains the header field names and values. Headers can be set when running the task is created or task is created. These headers represent a subset of the headers that will accompany the task's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is: * Any header that is prefixed with "X-Google-Cloud-Tasks-" will be treated as service header. Service headers define properties of the task and are predefined in CloudTask. * Host: This will be computed by Cloud Tasks and derived from HttpRequest.url. * Content-Length: This will be computed by Cloud Tasks. * User-Agent: This will be set to `"Google-Cloud-Tasks"`. * `X-Google-*`: Google use only. * `X-AppEngine-*`: Google use only. `Content-Type` won't be set by Cloud Tasks. You can explicitly set `Content-Type` to a media type when the task is created. For example, `Content-Type` can be set to `"application/octet-stream"` or `"application/json"`. Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values. The size of the headers must be less than 80KB. + "a_key": "A String", + }, + "httpMethod": "A String", # The HTTP method to use for the request. The default is POST. + "oauthToken": { # Contains information needed for generating an [OAuth token](https://developers.google.com/identity/protocols/OAuth2). This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. # If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. + "scope": "A String", # OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used. + "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OAuth token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account. + }, + "oidcToken": { # Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect). This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. # If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) token will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. + "audience": "A String", # Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used. + "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OIDC token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account. + }, + "url": "A String", # Required. The full url path that the request will be sent to. This string must begin with either "http://" or "https://". Some examples are: `http://acme.com` and `https://acme.com/sales:8080`. Cloud Tasks will encode some characters for safety and compatibility. The maximum allowed URL length is 2083 characters after encoding. The `Location` header response from a redirect response [`300` - `399`] may be followed. The redirect is not counted as a separate attempt. + }, "name": "A String", # Optionally caller-specified in CreateTask. The task name. The task name must have the following format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the task's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or hyphens (-). The maximum length is 100 characters. * `TASK_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters. "pullMessage": { # The pull message contains data that can be used by the caller of LeaseTasks to process the task. This proto can only be used for tasks in a queue which has pull_target set. # LeaseTasks to process the task. Can be set only if pull_target is set on the queue. A pull task is a task that has PullMessage set. "payload": "A String", # A data payload consumed by the worker to execute the task. @@ -750,6 +862,22 @@

Method Details

"relativeUrl": "A String", # The relative URL. The relative URL must begin with "/" and must be a valid HTTP relative URL. It can contain a path and query string arguments. If the relative URL is empty, then the root path "/" will be used. No spaces are allowed, and the maximum length allowed is 2083 characters. }, "createTime": "A String", # Output only. The time that the task was created. `create_time` will be truncated to the nearest second. + "httpRequest": { # HTTP request. The task will be pushed to the worker as an HTTP request. An HTTP request embodies a url, an http method, headers, body and authorization for the http task. # HTTP request that is sent to the task's target. An HTTP task is a task that has HttpRequest set. + "body": "A String", # HTTP request body. A request body is allowed only if the HTTP method is POST, PUT, or PATCH. It is an error to set body on a task with an incompatible HttpMethod. + "headers": { # HTTP request headers. This map contains the header field names and values. Headers can be set when running the task is created or task is created. These headers represent a subset of the headers that will accompany the task's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is: * Any header that is prefixed with "X-Google-Cloud-Tasks-" will be treated as service header. Service headers define properties of the task and are predefined in CloudTask. * Host: This will be computed by Cloud Tasks and derived from HttpRequest.url. * Content-Length: This will be computed by Cloud Tasks. * User-Agent: This will be set to `"Google-Cloud-Tasks"`. * `X-Google-*`: Google use only. * `X-AppEngine-*`: Google use only. `Content-Type` won't be set by Cloud Tasks. You can explicitly set `Content-Type` to a media type when the task is created. For example, `Content-Type` can be set to `"application/octet-stream"` or `"application/json"`. Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values. The size of the headers must be less than 80KB. + "a_key": "A String", + }, + "httpMethod": "A String", # The HTTP method to use for the request. The default is POST. + "oauthToken": { # Contains information needed for generating an [OAuth token](https://developers.google.com/identity/protocols/OAuth2). This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. # If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. + "scope": "A String", # OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used. + "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OAuth token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account. + }, + "oidcToken": { # Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect). This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. # If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) token will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. + "audience": "A String", # Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used. + "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OIDC token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account. + }, + "url": "A String", # Required. The full url path that the request will be sent to. This string must begin with either "http://" or "https://". Some examples are: `http://acme.com` and `https://acme.com/sales:8080`. Cloud Tasks will encode some characters for safety and compatibility. The maximum allowed URL length is 2083 characters after encoding. The `Location` header response from a redirect response [`300` - `399`] may be followed. The redirect is not counted as a separate attempt. + }, "name": "A String", # Optionally caller-specified in CreateTask. The task name. The task name must have the following format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the task's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or hyphens (-). The maximum length is 100 characters. * `TASK_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters. "pullMessage": { # The pull message contains data that can be used by the caller of LeaseTasks to process the task. This proto can only be used for tasks in a queue which has pull_target set. # LeaseTasks to process the task. Can be set only if pull_target is set on the queue. A pull task is a task that has PullMessage set. "payload": "A String", # A data payload consumed by the worker to execute the task. diff --git a/googleapiclient/discovery_cache/documents/cloudtasks.v2.json b/googleapiclient/discovery_cache/documents/cloudtasks.v2.json index 877bba2570d..a4ac2d3b79b 100644 --- a/googleapiclient/discovery_cache/documents/cloudtasks.v2.json +++ b/googleapiclient/discovery_cache/documents/cloudtasks.v2.json @@ -685,7 +685,7 @@ } } }, - "revision": "20220530", + "revision": "20220713", "rootUrl": "https://cloudtasks.googleapis.com/", "schemas": { "AppEngineHttpRequest": { diff --git a/googleapiclient/discovery_cache/documents/cloudtasks.v2beta2.json b/googleapiclient/discovery_cache/documents/cloudtasks.v2beta2.json index 8a2718627c7..7cfd6a36bf7 100644 --- a/googleapiclient/discovery_cache/documents/cloudtasks.v2beta2.json +++ b/googleapiclient/discovery_cache/documents/cloudtasks.v2beta2.json @@ -179,6 +179,34 @@ "resources": { "queues": { "methods": { + "buffer": { + "description": "Creates and buffers a new task without the need to explicitly define a Task message. The queue must be an http queue (i.e., must have HTTP target). This method is used for a simplified application of Cloud Tasks queues in buffer and rate limitting HTTP requests.", + "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}:buffer", + "httpMethod": "POST", + "id": "cloudtasks.projects.locations.queues.buffer", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The queue name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` The queue must already exist.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2beta2/{+name}:buffer", + "request": { + "$ref": "BufferQueueRequest" + }, + "response": { + "$ref": "BufferQueueResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "create": { "description": "Creates a queue. Queues created with this method allow tasks to live for a maximum of 31 days. After a task is 31 days old, the task will be deleted regardless of whether it was dispatched or not. WARNING: Using this method may have unintended side effects if you are using an App Engine `queue.yaml` or `queue.xml` file to manage your queues. Read [Overview of Queue Management and queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) before using this method.", "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues", @@ -809,7 +837,7 @@ } } }, - "revision": "20220530", + "revision": "20220713", "rootUrl": "https://cloudtasks.googleapis.com/", "schemas": { "AcknowledgeTaskRequest": { @@ -953,6 +981,28 @@ }, "type": "object" }, + "BufferQueueRequest": { + "description": "Request message for BufferQueue.", + "id": "BufferQueueRequest", + "properties": { + "body": { + "$ref": "HttpBody", + "description": "Body of the HTTP request. The body can take any generic value. The value will be written to the HttpRequest of the [Task]." + } + }, + "type": "object" + }, + "BufferQueueResponse": { + "description": "Response message for BufferQueue.", + "id": "BufferQueueResponse", + "properties": { + "task": { + "description": "The name of the created task. For example: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`. TASK_ID is randomly generated and is unique within the queue.", + "type": "string" + } + }, + "type": "object" + }, "CancelLeaseRequest": { "description": "Request message for canceling a lease using CancelLease.", "id": "CancelLeaseRequest", @@ -1056,6 +1106,156 @@ }, "type": "object" }, + "Header": { + "description": "Defines a header message. A header can have a key and a value.", + "id": "Header", + "properties": { + "key": { + "format": "byte", + "type": "string" + }, + "value": { + "format": "byte", + "type": "string" + } + }, + "type": "object" + }, + "HeaderOverride": { + "description": "Wraps the Header object.", + "id": "HeaderOverride", + "properties": { + "header": { + "$ref": "Header", + "description": "header embodying a key and a value." + } + }, + "type": "object" + }, + "HttpBody": { + "description": "Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.", + "id": "HttpBody", + "properties": { + "contentType": { + "description": "The HTTP Content-Type header value specifying the content type of the body.", + "type": "string" + }, + "data": { + "description": "The HTTP request/response body as raw binary.", + "format": "byte", + "type": "string" + }, + "extensions": { + "description": "Application specific response metadata. Must be set in the first response for streaming APIs.", + "items": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "HttpRequest": { + "description": "HTTP request. The task will be pushed to the worker as an HTTP request. An HTTP request embodies a url, an http method, headers, body and authorization for the http task.", + "id": "HttpRequest", + "properties": { + "body": { + "description": "HTTP request body. A request body is allowed only if the HTTP method is POST, PUT, or PATCH. It is an error to set body on a task with an incompatible HttpMethod.", + "format": "byte", + "type": "string" + }, + "headers": { + "additionalProperties": { + "type": "string" + }, + "description": "HTTP request headers. This map contains the header field names and values. Headers can be set when running the task is created or task is created. These headers represent a subset of the headers that will accompany the task's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is: * Any header that is prefixed with \"X-Google-Cloud-Tasks-\" will be treated as service header. Service headers define properties of the task and are predefined in CloudTask. * Host: This will be computed by Cloud Tasks and derived from HttpRequest.url. * Content-Length: This will be computed by Cloud Tasks. * User-Agent: This will be set to `\"Google-Cloud-Tasks\"`. * `X-Google-*`: Google use only. * `X-AppEngine-*`: Google use only. `Content-Type` won't be set by Cloud Tasks. You can explicitly set `Content-Type` to a media type when the task is created. For example, `Content-Type` can be set to `\"application/octet-stream\"` or `\"application/json\"`. Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values. The size of the headers must be less than 80KB.", + "type": "object" + }, + "httpMethod": { + "description": "The HTTP method to use for the request. The default is POST.", + "enum": [ + "HTTP_METHOD_UNSPECIFIED", + "POST", + "GET", + "HEAD", + "PUT", + "DELETE" + ], + "enumDescriptions": [ + "HTTP method unspecified", + "HTTP POST", + "HTTP GET", + "HTTP HEAD", + "HTTP PUT", + "HTTP DELETE" + ], + "type": "string" + }, + "oauthToken": { + "$ref": "OAuthToken", + "description": "If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com." + }, + "oidcToken": { + "$ref": "OidcToken", + "description": "If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) token will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself." + }, + "url": { + "description": "Required. The full url path that the request will be sent to. This string must begin with either \"http://\" or \"https://\". Some examples are: `http://acme.com` and `https://acme.com/sales:8080`. Cloud Tasks will encode some characters for safety and compatibility. The maximum allowed URL length is 2083 characters after encoding. The `Location` header response from a redirect response [`300` - `399`] may be followed. The redirect is not counted as a separate attempt.", + "type": "string" + } + }, + "type": "object" + }, + "HttpTarget": { + "description": "HTTP target. When specified as a Queue, all the tasks with [HttpRequest] will be overridden according to the target.", + "id": "HttpTarget", + "properties": { + "headerOverrides": { + "description": "HTTP target headers. This map contains the header field names and values. Headers will be set when running the task is created and/or task is created. These headers represent a subset of the headers that will accompany the task's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is: * Any header that is prefixed with \"X-Google-Cloud-Tasks-\" will be treated as service header. Service headers define properties of the task and are predefined in CloudTask. * Host: This will be computed by Cloud Tasks and derived from HttpRequest.url. * Content-Length: This will be computed by Cloud Tasks. * User-Agent: This will be set to `\"Google-Cloud-Tasks\"`. * `X-Google-*`: Google use only. * `X-AppEngine-*`: Google use only. `Content-Type` won't be set by Cloud Tasks. You can explicitly set `Content-Type` to a media type when the task is created. For example, `Content-Type` can be set to `\"application/octet-stream\"` or `\"application/json\"`. Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values. The size of the headers must be less than 80KB. Queue-level headers to override headers of all the tasks in the queue.", + "items": { + "$ref": "HeaderOverride" + }, + "type": "array" + }, + "httpMethod": { + "description": "The HTTP method to use for the request. When specified, it will override HttpRequest for the task. Note that if the value is set to HttpMethod the HttpRequest of the task will be ignored at execution time.", + "enum": [ + "HTTP_METHOD_UNSPECIFIED", + "POST", + "GET", + "HEAD", + "PUT", + "DELETE" + ], + "enumDescriptions": [ + "HTTP method unspecified", + "HTTP POST", + "HTTP GET", + "HTTP HEAD", + "HTTP PUT", + "HTTP DELETE" + ], + "type": "string" + }, + "oauthToken": { + "$ref": "OAuthToken", + "description": "If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com." + }, + "oidcToken": { + "$ref": "OidcToken", + "description": "If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) token will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself." + }, + "uriOverride": { + "$ref": "UriOverride", + "description": "Uri override. When specified modifies the execution Uri for all the tasks in the queue." + } + }, + "type": "object" + }, "LeaseTasksRequest": { "description": "Request message for leasing tasks using LeaseTasks.", "id": "LeaseTasksRequest", @@ -1193,6 +1393,36 @@ }, "type": "object" }, + "OAuthToken": { + "description": "Contains information needed for generating an [OAuth token](https://developers.google.com/identity/protocols/OAuth2). This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com.", + "id": "OAuthToken", + "properties": { + "scope": { + "description": "OAuth scope to be used for generating OAuth access token. If not specified, \"https://www.googleapis.com/auth/cloud-platform\" will be used.", + "type": "string" + }, + "serviceAccountEmail": { + "description": "[Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OAuth token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account.", + "type": "string" + } + }, + "type": "object" + }, + "OidcToken": { + "description": "Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect). This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself.", + "id": "OidcToken", + "properties": { + "audience": { + "description": "Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used.", + "type": "string" + }, + "serviceAccountEmail": { + "description": "[Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OIDC token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account.", + "type": "string" + } + }, + "type": "object" + }, "PauseQueueRequest": { "description": "Request message for PauseQueue.", "id": "PauseQueueRequest", @@ -1259,6 +1489,10 @@ "$ref": "AppEngineHttpTarget", "description": "App Engine HTTP target. An App Engine queue is a queue that has an AppEngineHttpTarget." }, + "httpTarget": { + "$ref": "HttpTarget", + "description": "An http_target is used to override the target values for HTTP tasks." + }, "name": { "description": "Caller-specified and required in CreateQueue, after which it becomes output only. The queue name. The queue name must have the following format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the queue's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or hyphens (-). The maximum length is 100 characters.", "type": "string" @@ -1518,6 +1752,10 @@ "format": "google-datetime", "type": "string" }, + "httpRequest": { + "$ref": "HttpRequest", + "description": "HTTP request that is sent to the task's target. An HTTP task is a task that has HttpRequest set." + }, "name": { "description": "Optionally caller-specified in CreateTask. The task name. The task name must have the following format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the task's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or hyphens (-). The maximum length is 100 characters. * `TASK_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters.", "type": "string" @@ -1604,6 +1842,44 @@ } }, "type": "object" + }, + "UriOverride": { + "description": "Uri Override. When specified, all the HTTP tasks inside the queue will be partially or fully overridden depending on the configured values.", + "id": "UriOverride", + "properties": { + "host": { + "description": "Host override. When specified, the host part of url will be overridden. For example, if the original Uri is \"https://www.google.com\", and host is set to \"example.net\", the overridden Uri will be \"https://example.net\".", + "type": "string" + }, + "path": { + "description": "Uri path. Will be used as the path for the current Uri (replaces any existing path of the task url).", + "type": "string" + }, + "port": { + "description": "Port override. When specified, the port part of Uri will be replaced by the provided value. For instance, for a Uri http://www.google.com/foo and port=123 the overridden Uri becomes http://www.google.com:123/foo.", + "format": "int64", + "type": "string" + }, + "query": { + "description": "Uri Query. Will replace the query part of the task uri.", + "type": "string" + }, + "scheme": { + "description": "Scheme override. When specified, the Uri scheme is replaced by the provided value.", + "enum": [ + "SCHEME_UNSPECIFIED", + "HTTP", + "HTTPS" + ], + "enumDescriptions": [ + "Scheme unspecified. Defaults to HTTPS.", + "Convert the scheme to HTTP, e.g., https://www.google.ca will change to http://www.google.ca.", + "Convert the scheme to HTTPS, e.g., http://www.google.ca will change to https://www.google.ca." + ], + "type": "string" + } + }, + "type": "object" } }, "servicePath": "", diff --git a/googleapiclient/discovery_cache/documents/cloudtasks.v2beta3.json b/googleapiclient/discovery_cache/documents/cloudtasks.v2beta3.json index d8c207a6685..8126a148c48 100644 --- a/googleapiclient/discovery_cache/documents/cloudtasks.v2beta3.json +++ b/googleapiclient/discovery_cache/documents/cloudtasks.v2beta3.json @@ -697,7 +697,7 @@ } } }, - "revision": "20220530", + "revision": "20220713", "rootUrl": "https://cloudtasks.googleapis.com/", "schemas": { "AppEngineHttpQueue": { From 0861cb7b948b7abb3dd0ac3d9482775ddb9e2564 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 19 Jul 2022 07:08:11 +0000 Subject: [PATCH 09/23] feat(connectors): update the api #### connectors:v1 The following keys were deleted: - schemas.Connection.properties.egressBackends (Total Keys: 3) The following keys were added: - schemas.AuthorizationCodeLink (Total Keys: 5) - schemas.ConfigVariableTemplate.properties.authorizationCodeLink.$ref (Total Keys: 1) - schemas.SshPublicKey.properties.sshClientCertPass.$ref (Total Keys: 1) --- ...ors_v1.projects.locations.connections.html | 26 +++++------ ...global_.providers.connectors.versions.html | 24 ++++++++++ .../documents/connectors.v1.json | 44 ++++++++++++++----- 3 files changed, 69 insertions(+), 25 deletions(-) diff --git a/docs/dyn/connectors_v1.projects.locations.connections.html b/docs/dyn/connectors_v1.projects.locations.connections.html index 54424e1ff95..001f16e3937 100644 --- a/docs/dyn/connectors_v1.projects.locations.connections.html +++ b/docs/dyn/connectors_v1.projects.locations.connections.html @@ -170,6 +170,9 @@

Method Details

"sshClientCert": { # Secret provides a reference to entries in Secret Manager. # SSH Client Cert. It should contain both public and private key. "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. }, + "sshClientCertPass": { # Secret provides a reference to entries in Secret Manager. # Password (passphrase) for ssh client certificate if it has one. + "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. + }, "username": "A String", # The user account used to authenticate. }, "userPassword": { # Parameters to support Username and Password Authentication. # UserPassword. @@ -193,9 +196,6 @@

Method Details

"connectorVersion": "A String", # Required. Connector version on which the connection is created. The format is: projects/*/locations/global/providers/*/connectors/*/versions/* "createTime": "A String", # Output only. Created time. "description": "A String", # Optional. Description of the resource. - "egressBackends": [ # Output only. Outbound domains/hosts needs to be allowlisted. - "A String", - ], "envoyImageLocation": "A String", # Output only. GCR location where the envoy image is stored. formatted like: gcr.io/{bucketName}/{imageName} "imageLocation": "A String", # Output only. GCR location where the runtime image is stored. formatted like: gcr.io/{bucketName}/{imageName} "labels": { # Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources @@ -339,6 +339,9 @@

Method Details

"sshClientCert": { # Secret provides a reference to entries in Secret Manager. # SSH Client Cert. It should contain both public and private key. "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. }, + "sshClientCertPass": { # Secret provides a reference to entries in Secret Manager. # Password (passphrase) for ssh client certificate if it has one. + "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. + }, "username": "A String", # The user account used to authenticate. }, "userPassword": { # Parameters to support Username and Password Authentication. # UserPassword. @@ -362,9 +365,6 @@

Method Details

"connectorVersion": "A String", # Required. Connector version on which the connection is created. The format is: projects/*/locations/global/providers/*/connectors/*/versions/* "createTime": "A String", # Output only. Created time. "description": "A String", # Optional. Description of the resource. - "egressBackends": [ # Output only. Outbound domains/hosts needs to be allowlisted. - "A String", - ], "envoyImageLocation": "A String", # Output only. GCR location where the envoy image is stored. formatted like: gcr.io/{bucketName}/{imageName} "imageLocation": "A String", # Output only. GCR location where the runtime image is stored. formatted like: gcr.io/{bucketName}/{imageName} "labels": { # Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources @@ -522,6 +522,9 @@

Method Details

"sshClientCert": { # Secret provides a reference to entries in Secret Manager. # SSH Client Cert. It should contain both public and private key. "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. }, + "sshClientCertPass": { # Secret provides a reference to entries in Secret Manager. # Password (passphrase) for ssh client certificate if it has one. + "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. + }, "username": "A String", # The user account used to authenticate. }, "userPassword": { # Parameters to support Username and Password Authentication. # UserPassword. @@ -545,9 +548,6 @@

Method Details

"connectorVersion": "A String", # Required. Connector version on which the connection is created. The format is: projects/*/locations/global/providers/*/connectors/*/versions/* "createTime": "A String", # Output only. Created time. "description": "A String", # Optional. Description of the resource. - "egressBackends": [ # Output only. Outbound domains/hosts needs to be allowlisted. - "A String", - ], "envoyImageLocation": "A String", # Output only. GCR location where the envoy image is stored. formatted like: gcr.io/{bucketName}/{imageName} "imageLocation": "A String", # Output only. GCR location where the runtime image is stored. formatted like: gcr.io/{bucketName}/{imageName} "labels": { # Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources @@ -637,6 +637,9 @@

Method Details

"sshClientCert": { # Secret provides a reference to entries in Secret Manager. # SSH Client Cert. It should contain both public and private key. "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. }, + "sshClientCertPass": { # Secret provides a reference to entries in Secret Manager. # Password (passphrase) for ssh client certificate if it has one. + "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. + }, "username": "A String", # The user account used to authenticate. }, "userPassword": { # Parameters to support Username and Password Authentication. # UserPassword. @@ -660,9 +663,6 @@

Method Details

"connectorVersion": "A String", # Required. Connector version on which the connection is created. The format is: projects/*/locations/global/providers/*/connectors/*/versions/* "createTime": "A String", # Output only. Created time. "description": "A String", # Optional. Description of the resource. - "egressBackends": [ # Output only. Outbound domains/hosts needs to be allowlisted. - "A String", - ], "envoyImageLocation": "A String", # Output only. GCR location where the envoy image is stored. formatted like: gcr.io/{bucketName}/{imageName} "imageLocation": "A String", # Output only. GCR location where the runtime image is stored. formatted like: gcr.io/{bucketName}/{imageName} "labels": { # Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources @@ -684,7 +684,7 @@

Method Details

"updateTime": "A String", # Output only. Updated time. } - updateMask: string, Field mask is used to specify the fields to be overwritten in the Connection resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. + updateMask: string, Required. Field mask is used to specify the fields to be overwritten in the Connection resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/connectors_v1.projects.locations.global_.providers.connectors.versions.html b/docs/dyn/connectors_v1.projects.locations.global_.providers.connectors.versions.html index fef310bdb2a..e3b682f744f 100644 --- a/docs/dyn/connectors_v1.projects.locations.global_.providers.connectors.versions.html +++ b/docs/dyn/connectors_v1.projects.locations.global_.providers.connectors.versions.html @@ -117,6 +117,12 @@

Method Details

"authType": "A String", # The type of authentication configured. "configVariableTemplates": [ # Config variables to describe an `AuthConfig` for a `Connection`. { # ConfigVariableTemplate provides metadata about a `ConfigVariable` that is used in a Connection. + "authorizationCodeLink": { # This configuration captures the details required to render an authorization link for the OAuth Authorization Code Flow. # Authorization code link options. To be populated if `ValueType` is `AUTHORIZATION_CODE` + "scopes": [ # The scopes for which the user will authorize GCP Connectors on the connector data source. + "A String", + ], + "uri": "A String", # The base URI the user must click to trigger the authorization code login flow. + }, "description": "A String", # Description. "displayName": "A String", # Display name of the parameter. "enumOptions": [ # Enum options. To be populated if `ValueType` is `ENUM` @@ -146,6 +152,12 @@

Method Details

], "configVariableTemplates": [ # Output only. List of config variables needed to create a connection. { # ConfigVariableTemplate provides metadata about a `ConfigVariable` that is used in a Connection. + "authorizationCodeLink": { # This configuration captures the details required to render an authorization link for the OAuth Authorization Code Flow. # Authorization code link options. To be populated if `ValueType` is `AUTHORIZATION_CODE` + "scopes": [ # The scopes for which the user will authorize GCP Connectors on the connector data source. + "A String", + ], + "uri": "A String", # The base URI the user must click to trigger the authorization code login flow. + }, "description": "A String", # Description. "displayName": "A String", # Display name of the parameter. "enumOptions": [ # Enum options. To be populated if `ValueType` is `ENUM` @@ -255,6 +267,12 @@

Method Details

"authType": "A String", # The type of authentication configured. "configVariableTemplates": [ # Config variables to describe an `AuthConfig` for a `Connection`. { # ConfigVariableTemplate provides metadata about a `ConfigVariable` that is used in a Connection. + "authorizationCodeLink": { # This configuration captures the details required to render an authorization link for the OAuth Authorization Code Flow. # Authorization code link options. To be populated if `ValueType` is `AUTHORIZATION_CODE` + "scopes": [ # The scopes for which the user will authorize GCP Connectors on the connector data source. + "A String", + ], + "uri": "A String", # The base URI the user must click to trigger the authorization code login flow. + }, "description": "A String", # Description. "displayName": "A String", # Display name of the parameter. "enumOptions": [ # Enum options. To be populated if `ValueType` is `ENUM` @@ -284,6 +302,12 @@

Method Details

], "configVariableTemplates": [ # Output only. List of config variables needed to create a connection. { # ConfigVariableTemplate provides metadata about a `ConfigVariable` that is used in a Connection. + "authorizationCodeLink": { # This configuration captures the details required to render an authorization link for the OAuth Authorization Code Flow. # Authorization code link options. To be populated if `ValueType` is `AUTHORIZATION_CODE` + "scopes": [ # The scopes for which the user will authorize GCP Connectors on the connector data source. + "A String", + ], + "uri": "A String", # The base URI the user must click to trigger the authorization code login flow. + }, "description": "A String", # Description. "displayName": "A String", # Display name of the parameter. "enumOptions": [ # Enum options. To be populated if `ValueType` is `ENUM` diff --git a/googleapiclient/discovery_cache/documents/connectors.v1.json b/googleapiclient/discovery_cache/documents/connectors.v1.json index e570663aa7c..427688a2592 100644 --- a/googleapiclient/discovery_cache/documents/connectors.v1.json +++ b/googleapiclient/discovery_cache/documents/connectors.v1.json @@ -436,7 +436,7 @@ "type": "string" }, "updateMask": { - "description": "Field mask is used to specify the fields to be overwritten in the Connection resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", + "description": "Required. Field mask is used to specify the fields to be overwritten in the Connection resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -1055,7 +1055,7 @@ } } }, - "revision": "20220616", + "revision": "20220707", "rootUrl": "https://connectors.googleapis.com/", "schemas": { "AuditConfig": { @@ -1186,6 +1186,24 @@ }, "type": "object" }, + "AuthorizationCodeLink": { + "description": "This configuration captures the details required to render an authorization link for the OAuth Authorization Code Flow.", + "id": "AuthorizationCodeLink", + "properties": { + "scopes": { + "description": "The scopes for which the user will authorize GCP Connectors on the connector data source.", + "items": { + "type": "string" + }, + "type": "array" + }, + "uri": { + "description": "The base URI the user must click to trigger the authorization code login flow.", + "type": "string" + } + }, + "type": "object" + }, "Binding": { "description": "Associates `members`, or principals, with a `role`.", "id": "Binding", @@ -1246,6 +1264,10 @@ "description": "ConfigVariableTemplate provides metadata about a `ConfigVariable` that is used in a Connection.", "id": "ConfigVariableTemplate", "properties": { + "authorizationCodeLink": { + "$ref": "AuthorizationCodeLink", + "description": "Authorization code link options. To be populated if `ValueType` is `AUTHORIZATION_CODE`" + }, "description": { "description": "Description.", "type": "string" @@ -1285,7 +1307,8 @@ "INT", "BOOL", "SECRET", - "ENUM" + "ENUM", + "AUTHORIZATION_CODE" ], "enumDescriptions": [ "Value type is not specified.", @@ -1293,7 +1316,8 @@ "Value type is integer.", "Value type is boolean.", "Value type is secret.", - "Value type is enum." + "Value type is enum.", + "Value type is authorization code." ], "type": "string" } @@ -1329,14 +1353,6 @@ "description": "Optional. Description of the resource.", "type": "string" }, - "egressBackends": { - "description": "Output only. Outbound domains/hosts needs to be allowlisted.", - "items": { - "type": "string" - }, - "readOnly": true, - "type": "array" - }, "envoyImageLocation": { "description": "Output only. GCR location where the envoy image is stored. formatted like: gcr.io/{bucketName}/{imageName}", "readOnly": true, @@ -2782,6 +2798,10 @@ "$ref": "Secret", "description": "SSH Client Cert. It should contain both public and private key." }, + "sshClientCertPass": { + "$ref": "Secret", + "description": "Password (passphrase) for ssh client certificate if it has one." + }, "username": { "description": "The user account used to authenticate.", "type": "string" From afe85f56e58475e5a51ca46b1a0c8f304e3d1d38 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 19 Jul 2022 07:08:11 +0000 Subject: [PATCH 10/23] feat(containeranalysis): update the api #### containeranalysis:v1 The following keys were added: - schemas.AnalysisCompleted (Total Keys: 4) - schemas.DiscoveryOccurrence.properties.analysisCompleted.$ref (Total Keys: 1) - schemas.DiscoveryOccurrence.properties.analysisError (Total Keys: 2) #### containeranalysis:v1alpha1 The following keys were added: - schemas.ComplianceVersion.properties.benchmarkDocument.type (Total Keys: 1) #### containeranalysis:v1beta1 The following keys were added: - schemas.AnalysisCompleted (Total Keys: 4) - schemas.Discovered.properties.analysisCompleted.$ref (Total Keys: 1) - schemas.Discovered.properties.analysisError (Total Keys: 2) --- ...nalysis_v1.projects.notes.occurrences.html | 16 +++ ...aineranalysis_v1.projects.occurrences.html | 128 ++++++++++++++++++ ...aineranalysis_v1alpha1.projects.notes.html | 6 + ...nalysis_v1alpha1.projects.occurrences.html | 1 + ...ineranalysis_v1alpha1.providers.notes.html | 6 + ...is_v1beta1.projects.notes.occurrences.html | 16 +++ ...analysis_v1beta1.projects.occurrences.html | 128 ++++++++++++++++++ .../documents/containeranalysis.v1.json | 29 +++- .../documents/containeranalysis.v1alpha1.json | 6 +- .../documents/containeranalysis.v1beta1.json | 27 +++- 10 files changed, 359 insertions(+), 4 deletions(-) diff --git a/docs/dyn/containeranalysis_v1.projects.notes.occurrences.html b/docs/dyn/containeranalysis_v1.projects.notes.occurrences.html index 1391d5938c6..f1883acdb64 100644 --- a/docs/dyn/containeranalysis_v1.projects.notes.occurrences.html +++ b/docs/dyn/containeranalysis_v1.projects.notes.occurrences.html @@ -426,6 +426,22 @@

Method Details

"userEmail": "A String", # Identity of the user that triggered this deployment. }, "discovery": { # Provides information about the analysis status of a discovered resource. # Describes when a resource was discovered. + "analysisCompleted": { # Indicates which analysis completed successfully. Multiple types of analysis can be performed on a single resource. + "analysisType": [ + "A String", + ], + }, + "analysisError": [ # Indicates any errors encountered during analysis of a resource. There could be 0 or more of these errors. + { # 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). + "code": 42, # The status code, which should be an enum value of google.rpc.Code. + "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. + { + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + ], + "message": "A String", # 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. + }, + ], "analysisStatus": "A String", # The status of discovery for the resource. "analysisStatusError": { # 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). # When an error is encountered this will contain a LocalizedMessage under details to show to the user. The LocalizedMessage is output only and populated by the API. "code": 42, # The status code, which should be an enum value of google.rpc.Code. diff --git a/docs/dyn/containeranalysis_v1.projects.occurrences.html b/docs/dyn/containeranalysis_v1.projects.occurrences.html index 235650af132..fa65fda9c41 100644 --- a/docs/dyn/containeranalysis_v1.projects.occurrences.html +++ b/docs/dyn/containeranalysis_v1.projects.occurrences.html @@ -442,6 +442,22 @@

Method Details

"userEmail": "A String", # Identity of the user that triggered this deployment. }, "discovery": { # Provides information about the analysis status of a discovered resource. # Describes when a resource was discovered. + "analysisCompleted": { # Indicates which analysis completed successfully. Multiple types of analysis can be performed on a single resource. + "analysisType": [ + "A String", + ], + }, + "analysisError": [ # Indicates any errors encountered during analysis of a resource. There could be 0 or more of these errors. + { # 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). + "code": 42, # The status code, which should be an enum value of google.rpc.Code. + "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. + { + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + ], + "message": "A String", # 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. + }, + ], "analysisStatus": "A String", # The status of discovery for the resource. "analysisStatusError": { # 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). # When an error is encountered this will contain a LocalizedMessage under details to show to the user. The LocalizedMessage is output only and populated by the API. "code": 42, # The status code, which should be an enum value of google.rpc.Code. @@ -1088,6 +1104,22 @@

Method Details

"userEmail": "A String", # Identity of the user that triggered this deployment. }, "discovery": { # Provides information about the analysis status of a discovered resource. # Describes when a resource was discovered. + "analysisCompleted": { # Indicates which analysis completed successfully. Multiple types of analysis can be performed on a single resource. + "analysisType": [ + "A String", + ], + }, + "analysisError": [ # Indicates any errors encountered during analysis of a resource. There could be 0 or more of these errors. + { # 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). + "code": 42, # The status code, which should be an enum value of google.rpc.Code. + "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. + { + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + ], + "message": "A String", # 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. + }, + ], "analysisStatus": "A String", # The status of discovery for the resource. "analysisStatusError": { # 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). # When an error is encountered this will contain a LocalizedMessage under details to show to the user. The LocalizedMessage is output only and populated by the API. "code": 42, # The status code, which should be an enum value of google.rpc.Code. @@ -1739,6 +1771,22 @@

Method Details

"userEmail": "A String", # Identity of the user that triggered this deployment. }, "discovery": { # Provides information about the analysis status of a discovered resource. # Describes when a resource was discovered. + "analysisCompleted": { # Indicates which analysis completed successfully. Multiple types of analysis can be performed on a single resource. + "analysisType": [ + "A String", + ], + }, + "analysisError": [ # Indicates any errors encountered during analysis of a resource. There could be 0 or more of these errors. + { # 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). + "code": 42, # The status code, which should be an enum value of google.rpc.Code. + "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. + { + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + ], + "message": "A String", # 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. + }, + ], "analysisStatus": "A String", # The status of discovery for the resource. "analysisStatusError": { # 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). # When an error is encountered this will contain a LocalizedMessage under details to show to the user. The LocalizedMessage is output only and populated by the API. "code": 42, # The status code, which should be an enum value of google.rpc.Code. @@ -2381,6 +2429,22 @@

Method Details

"userEmail": "A String", # Identity of the user that triggered this deployment. }, "discovery": { # Provides information about the analysis status of a discovered resource. # Describes when a resource was discovered. + "analysisCompleted": { # Indicates which analysis completed successfully. Multiple types of analysis can be performed on a single resource. + "analysisType": [ + "A String", + ], + }, + "analysisError": [ # Indicates any errors encountered during analysis of a resource. There could be 0 or more of these errors. + { # 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). + "code": 42, # The status code, which should be an enum value of google.rpc.Code. + "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. + { + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + ], + "message": "A String", # 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. + }, + ], "analysisStatus": "A String", # The status of discovery for the resource. "analysisStatusError": { # 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). # When an error is encountered this will contain a LocalizedMessage under details to show to the user. The LocalizedMessage is output only and populated by the API. "code": 42, # The status code, which should be an enum value of google.rpc.Code. @@ -3048,6 +3112,22 @@

Method Details

"userEmail": "A String", # Identity of the user that triggered this deployment. }, "discovery": { # Provides information about the analysis status of a discovered resource. # Describes when a resource was discovered. + "analysisCompleted": { # Indicates which analysis completed successfully. Multiple types of analysis can be performed on a single resource. + "analysisType": [ + "A String", + ], + }, + "analysisError": [ # Indicates any errors encountered during analysis of a resource. There could be 0 or more of these errors. + { # 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). + "code": 42, # The status code, which should be an enum value of google.rpc.Code. + "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. + { + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + ], + "message": "A String", # 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. + }, + ], "analysisStatus": "A String", # The status of discovery for the resource. "analysisStatusError": { # 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). # When an error is encountered this will contain a LocalizedMessage under details to show to the user. The LocalizedMessage is output only and populated by the API. "code": 42, # The status code, which should be an enum value of google.rpc.Code. @@ -4010,6 +4090,22 @@

Method Details

"userEmail": "A String", # Identity of the user that triggered this deployment. }, "discovery": { # Provides information about the analysis status of a discovered resource. # Describes when a resource was discovered. + "analysisCompleted": { # Indicates which analysis completed successfully. Multiple types of analysis can be performed on a single resource. + "analysisType": [ + "A String", + ], + }, + "analysisError": [ # Indicates any errors encountered during analysis of a resource. There could be 0 or more of these errors. + { # 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). + "code": 42, # The status code, which should be an enum value of google.rpc.Code. + "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. + { + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + ], + "message": "A String", # 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. + }, + ], "analysisStatus": "A String", # The status of discovery for the resource. "analysisStatusError": { # 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). # When an error is encountered this will contain a LocalizedMessage under details to show to the user. The LocalizedMessage is output only and populated by the API. "code": 42, # The status code, which should be an enum value of google.rpc.Code. @@ -4670,6 +4766,22 @@

Method Details

"userEmail": "A String", # Identity of the user that triggered this deployment. }, "discovery": { # Provides information about the analysis status of a discovered resource. # Describes when a resource was discovered. + "analysisCompleted": { # Indicates which analysis completed successfully. Multiple types of analysis can be performed on a single resource. + "analysisType": [ + "A String", + ], + }, + "analysisError": [ # Indicates any errors encountered during analysis of a resource. There could be 0 or more of these errors. + { # 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). + "code": 42, # The status code, which should be an enum value of google.rpc.Code. + "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. + { + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + ], + "message": "A String", # 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. + }, + ], "analysisStatus": "A String", # The status of discovery for the resource. "analysisStatusError": { # 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). # When an error is encountered this will contain a LocalizedMessage under details to show to the user. The LocalizedMessage is output only and populated by the API. "code": 42, # The status code, which should be an enum value of google.rpc.Code. @@ -5313,6 +5425,22 @@

Method Details

"userEmail": "A String", # Identity of the user that triggered this deployment. }, "discovery": { # Provides information about the analysis status of a discovered resource. # Describes when a resource was discovered. + "analysisCompleted": { # Indicates which analysis completed successfully. Multiple types of analysis can be performed on a single resource. + "analysisType": [ + "A String", + ], + }, + "analysisError": [ # Indicates any errors encountered during analysis of a resource. There could be 0 or more of these errors. + { # 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). + "code": 42, # The status code, which should be an enum value of google.rpc.Code. + "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. + { + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + ], + "message": "A String", # 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. + }, + ], "analysisStatus": "A String", # The status of discovery for the resource. "analysisStatusError": { # 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). # When an error is encountered this will contain a LocalizedMessage under details to show to the user. The LocalizedMessage is output only and populated by the API. "code": 42, # The status code, which should be an enum value of google.rpc.Code. diff --git a/docs/dyn/containeranalysis_v1alpha1.projects.notes.html b/docs/dyn/containeranalysis_v1alpha1.projects.notes.html index d4f3fe302b0..46e12deb6bc 100644 --- a/docs/dyn/containeranalysis_v1alpha1.projects.notes.html +++ b/docs/dyn/containeranalysis_v1alpha1.projects.notes.html @@ -161,6 +161,7 @@

Method Details

"title": "A String", # The title that identifies this compliance check. "version": [ # The OS and config versions the benchmark applies to. { # Describes the CIS benchmark version that is applicable to a given OS and os version. + "benchmarkDocument": "A String", # The name of the document that defines this benchmark, e.g. "CIS Container-Optimized OS". "cpeUri": "A String", # The CPE URI (https://cpe.mitre.org/specification/) this benchmark is applicable to. "version": "A String", # The version of the benchmark. This is set to the version of the OS-specific CIS document the benchmark is defined in. }, @@ -411,6 +412,7 @@

Method Details

"title": "A String", # The title that identifies this compliance check. "version": [ # The OS and config versions the benchmark applies to. { # Describes the CIS benchmark version that is applicable to a given OS and os version. + "benchmarkDocument": "A String", # The name of the document that defines this benchmark, e.g. "CIS Container-Optimized OS". "cpeUri": "A String", # The CPE URI (https://cpe.mitre.org/specification/) this benchmark is applicable to. "version": "A String", # The version of the benchmark. This is set to the version of the OS-specific CIS document the benchmark is defined in. }, @@ -684,6 +686,7 @@

Method Details

"title": "A String", # The title that identifies this compliance check. "version": [ # The OS and config versions the benchmark applies to. { # Describes the CIS benchmark version that is applicable to a given OS and os version. + "benchmarkDocument": "A String", # The name of the document that defines this benchmark, e.g. "CIS Container-Optimized OS". "cpeUri": "A String", # The CPE URI (https://cpe.mitre.org/specification/) this benchmark is applicable to. "version": "A String", # The version of the benchmark. This is set to the version of the OS-specific CIS document the benchmark is defined in. }, @@ -989,6 +992,7 @@

Method Details

"title": "A String", # The title that identifies this compliance check. "version": [ # The OS and config versions the benchmark applies to. { # Describes the CIS benchmark version that is applicable to a given OS and os version. + "benchmarkDocument": "A String", # The name of the document that defines this benchmark, e.g. "CIS Container-Optimized OS". "cpeUri": "A String", # The CPE URI (https://cpe.mitre.org/specification/) this benchmark is applicable to. "version": "A String", # The version of the benchmark. This is set to the version of the OS-specific CIS document the benchmark is defined in. }, @@ -1255,6 +1259,7 @@

Method Details

"title": "A String", # The title that identifies this compliance check. "version": [ # The OS and config versions the benchmark applies to. { # Describes the CIS benchmark version that is applicable to a given OS and os version. + "benchmarkDocument": "A String", # The name of the document that defines this benchmark, e.g. "CIS Container-Optimized OS". "cpeUri": "A String", # The CPE URI (https://cpe.mitre.org/specification/) this benchmark is applicable to. "version": "A String", # The version of the benchmark. This is set to the version of the OS-specific CIS document the benchmark is defined in. }, @@ -1504,6 +1509,7 @@

Method Details

"title": "A String", # The title that identifies this compliance check. "version": [ # The OS and config versions the benchmark applies to. { # Describes the CIS benchmark version that is applicable to a given OS and os version. + "benchmarkDocument": "A String", # The name of the document that defines this benchmark, e.g. "CIS Container-Optimized OS". "cpeUri": "A String", # The CPE URI (https://cpe.mitre.org/specification/) this benchmark is applicable to. "version": "A String", # The version of the benchmark. This is set to the version of the OS-specific CIS document the benchmark is defined in. }, diff --git a/docs/dyn/containeranalysis_v1alpha1.projects.occurrences.html b/docs/dyn/containeranalysis_v1alpha1.projects.occurrences.html index 476db499f4a..b3763803d67 100644 --- a/docs/dyn/containeranalysis_v1alpha1.projects.occurrences.html +++ b/docs/dyn/containeranalysis_v1alpha1.projects.occurrences.html @@ -2368,6 +2368,7 @@

Method Details

"title": "A String", # The title that identifies this compliance check. "version": [ # The OS and config versions the benchmark applies to. { # Describes the CIS benchmark version that is applicable to a given OS and os version. + "benchmarkDocument": "A String", # The name of the document that defines this benchmark, e.g. "CIS Container-Optimized OS". "cpeUri": "A String", # The CPE URI (https://cpe.mitre.org/specification/) this benchmark is applicable to. "version": "A String", # The version of the benchmark. This is set to the version of the OS-specific CIS document the benchmark is defined in. }, diff --git a/docs/dyn/containeranalysis_v1alpha1.providers.notes.html b/docs/dyn/containeranalysis_v1alpha1.providers.notes.html index e954e18551b..b0a83affa2d 100644 --- a/docs/dyn/containeranalysis_v1alpha1.providers.notes.html +++ b/docs/dyn/containeranalysis_v1alpha1.providers.notes.html @@ -161,6 +161,7 @@

Method Details

"title": "A String", # The title that identifies this compliance check. "version": [ # The OS and config versions the benchmark applies to. { # Describes the CIS benchmark version that is applicable to a given OS and os version. + "benchmarkDocument": "A String", # The name of the document that defines this benchmark, e.g. "CIS Container-Optimized OS". "cpeUri": "A String", # The CPE URI (https://cpe.mitre.org/specification/) this benchmark is applicable to. "version": "A String", # The version of the benchmark. This is set to the version of the OS-specific CIS document the benchmark is defined in. }, @@ -411,6 +412,7 @@

Method Details

"title": "A String", # The title that identifies this compliance check. "version": [ # The OS and config versions the benchmark applies to. { # Describes the CIS benchmark version that is applicable to a given OS and os version. + "benchmarkDocument": "A String", # The name of the document that defines this benchmark, e.g. "CIS Container-Optimized OS". "cpeUri": "A String", # The CPE URI (https://cpe.mitre.org/specification/) this benchmark is applicable to. "version": "A String", # The version of the benchmark. This is set to the version of the OS-specific CIS document the benchmark is defined in. }, @@ -684,6 +686,7 @@

Method Details

"title": "A String", # The title that identifies this compliance check. "version": [ # The OS and config versions the benchmark applies to. { # Describes the CIS benchmark version that is applicable to a given OS and os version. + "benchmarkDocument": "A String", # The name of the document that defines this benchmark, e.g. "CIS Container-Optimized OS". "cpeUri": "A String", # The CPE URI (https://cpe.mitre.org/specification/) this benchmark is applicable to. "version": "A String", # The version of the benchmark. This is set to the version of the OS-specific CIS document the benchmark is defined in. }, @@ -989,6 +992,7 @@

Method Details

"title": "A String", # The title that identifies this compliance check. "version": [ # The OS and config versions the benchmark applies to. { # Describes the CIS benchmark version that is applicable to a given OS and os version. + "benchmarkDocument": "A String", # The name of the document that defines this benchmark, e.g. "CIS Container-Optimized OS". "cpeUri": "A String", # The CPE URI (https://cpe.mitre.org/specification/) this benchmark is applicable to. "version": "A String", # The version of the benchmark. This is set to the version of the OS-specific CIS document the benchmark is defined in. }, @@ -1255,6 +1259,7 @@

Method Details

"title": "A String", # The title that identifies this compliance check. "version": [ # The OS and config versions the benchmark applies to. { # Describes the CIS benchmark version that is applicable to a given OS and os version. + "benchmarkDocument": "A String", # The name of the document that defines this benchmark, e.g. "CIS Container-Optimized OS". "cpeUri": "A String", # The CPE URI (https://cpe.mitre.org/specification/) this benchmark is applicable to. "version": "A String", # The version of the benchmark. This is set to the version of the OS-specific CIS document the benchmark is defined in. }, @@ -1504,6 +1509,7 @@

Method Details

"title": "A String", # The title that identifies this compliance check. "version": [ # The OS and config versions the benchmark applies to. { # Describes the CIS benchmark version that is applicable to a given OS and os version. + "benchmarkDocument": "A String", # The name of the document that defines this benchmark, e.g. "CIS Container-Optimized OS". "cpeUri": "A String", # The CPE URI (https://cpe.mitre.org/specification/) this benchmark is applicable to. "version": "A String", # The version of the benchmark. This is set to the version of the OS-specific CIS document the benchmark is defined in. }, diff --git a/docs/dyn/containeranalysis_v1beta1.projects.notes.occurrences.html b/docs/dyn/containeranalysis_v1beta1.projects.notes.occurrences.html index ab03fe21eac..8d9a45d804f 100644 --- a/docs/dyn/containeranalysis_v1beta1.projects.notes.occurrences.html +++ b/docs/dyn/containeranalysis_v1beta1.projects.notes.occurrences.html @@ -285,6 +285,22 @@

Method Details

}, "discovered": { # Details of a discovery occurrence. # Describes when a resource was discovered. "discovered": { # Provides information about the analysis status of a discovered resource. # Required. Analysis status for the discovered resource. + "analysisCompleted": { # Indicates which analysis completed successfully. Multiple types of analysis can be performed on a single resource. + "analysisType": [ + "A String", + ], + }, + "analysisError": [ # Indicates any errors encountered during analysis of a resource. There could be 0 or more of these errors. + { # 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). + "code": 42, # The status code, which should be an enum value of google.rpc.Code. + "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. + { + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + ], + "message": "A String", # 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. + }, + ], "analysisStatus": "A String", # The status of discovery for the resource. "analysisStatusError": { # 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). # When an error is encountered this will contain a LocalizedMessage under details to show to the user. The LocalizedMessage is output only and populated by the API. "code": 42, # The status code, which should be an enum value of google.rpc.Code. diff --git a/docs/dyn/containeranalysis_v1beta1.projects.occurrences.html b/docs/dyn/containeranalysis_v1beta1.projects.occurrences.html index 2eb62ad4c5f..54c7587b022 100644 --- a/docs/dyn/containeranalysis_v1beta1.projects.occurrences.html +++ b/docs/dyn/containeranalysis_v1beta1.projects.occurrences.html @@ -301,6 +301,22 @@

Method Details

}, "discovered": { # Details of a discovery occurrence. # Describes when a resource was discovered. "discovered": { # Provides information about the analysis status of a discovered resource. # Required. Analysis status for the discovered resource. + "analysisCompleted": { # Indicates which analysis completed successfully. Multiple types of analysis can be performed on a single resource. + "analysisType": [ + "A String", + ], + }, + "analysisError": [ # Indicates any errors encountered during analysis of a resource. There could be 0 or more of these errors. + { # 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). + "code": 42, # The status code, which should be an enum value of google.rpc.Code. + "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. + { + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + ], + "message": "A String", # 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. + }, + ], "analysisStatus": "A String", # The status of discovery for the resource. "analysisStatusError": { # 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). # When an error is encountered this will contain a LocalizedMessage under details to show to the user. The LocalizedMessage is output only and populated by the API. "code": 42, # The status code, which should be an enum value of google.rpc.Code. @@ -697,6 +713,22 @@

Method Details

}, "discovered": { # Details of a discovery occurrence. # Describes when a resource was discovered. "discovered": { # Provides information about the analysis status of a discovered resource. # Required. Analysis status for the discovered resource. + "analysisCompleted": { # Indicates which analysis completed successfully. Multiple types of analysis can be performed on a single resource. + "analysisType": [ + "A String", + ], + }, + "analysisError": [ # Indicates any errors encountered during analysis of a resource. There could be 0 or more of these errors. + { # 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). + "code": 42, # The status code, which should be an enum value of google.rpc.Code. + "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. + { + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + ], + "message": "A String", # 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. + }, + ], "analysisStatus": "A String", # The status of discovery for the resource. "analysisStatusError": { # 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). # When an error is encountered this will contain a LocalizedMessage under details to show to the user. The LocalizedMessage is output only and populated by the API. "code": 42, # The status code, which should be an enum value of google.rpc.Code. @@ -1098,6 +1130,22 @@

Method Details

}, "discovered": { # Details of a discovery occurrence. # Describes when a resource was discovered. "discovered": { # Provides information about the analysis status of a discovered resource. # Required. Analysis status for the discovered resource. + "analysisCompleted": { # Indicates which analysis completed successfully. Multiple types of analysis can be performed on a single resource. + "analysisType": [ + "A String", + ], + }, + "analysisError": [ # Indicates any errors encountered during analysis of a resource. There could be 0 or more of these errors. + { # 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). + "code": 42, # The status code, which should be an enum value of google.rpc.Code. + "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. + { + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + ], + "message": "A String", # 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. + }, + ], "analysisStatus": "A String", # The status of discovery for the resource. "analysisStatusError": { # 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). # When an error is encountered this will contain a LocalizedMessage under details to show to the user. The LocalizedMessage is output only and populated by the API. "code": 42, # The status code, which should be an enum value of google.rpc.Code. @@ -1490,6 +1538,22 @@

Method Details

}, "discovered": { # Details of a discovery occurrence. # Describes when a resource was discovered. "discovered": { # Provides information about the analysis status of a discovered resource. # Required. Analysis status for the discovered resource. + "analysisCompleted": { # Indicates which analysis completed successfully. Multiple types of analysis can be performed on a single resource. + "analysisType": [ + "A String", + ], + }, + "analysisError": [ # Indicates any errors encountered during analysis of a resource. There could be 0 or more of these errors. + { # 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). + "code": 42, # The status code, which should be an enum value of google.rpc.Code. + "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. + { + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + ], + "message": "A String", # 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. + }, + ], "analysisStatus": "A String", # The status of discovery for the resource. "analysisStatusError": { # 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). # When an error is encountered this will contain a LocalizedMessage under details to show to the user. The LocalizedMessage is output only and populated by the API. "code": 42, # The status code, which should be an enum value of google.rpc.Code. @@ -1907,6 +1971,22 @@

Method Details

}, "discovered": { # Details of a discovery occurrence. # Describes when a resource was discovered. "discovered": { # Provides information about the analysis status of a discovered resource. # Required. Analysis status for the discovered resource. + "analysisCompleted": { # Indicates which analysis completed successfully. Multiple types of analysis can be performed on a single resource. + "analysisType": [ + "A String", + ], + }, + "analysisError": [ # Indicates any errors encountered during analysis of a resource. There could be 0 or more of these errors. + { # 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). + "code": 42, # The status code, which should be an enum value of google.rpc.Code. + "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. + { + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + ], + "message": "A String", # 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. + }, + ], "analysisStatus": "A String", # The status of discovery for the resource. "analysisStatusError": { # 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). # When an error is encountered this will contain a LocalizedMessage under details to show to the user. The LocalizedMessage is output only and populated by the API. "code": 42, # The status code, which should be an enum value of google.rpc.Code. @@ -2657,6 +2737,22 @@

Method Details

}, "discovered": { # Details of a discovery occurrence. # Describes when a resource was discovered. "discovered": { # Provides information about the analysis status of a discovered resource. # Required. Analysis status for the discovered resource. + "analysisCompleted": { # Indicates which analysis completed successfully. Multiple types of analysis can be performed on a single resource. + "analysisType": [ + "A String", + ], + }, + "analysisError": [ # Indicates any errors encountered during analysis of a resource. There could be 0 or more of these errors. + { # 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). + "code": 42, # The status code, which should be an enum value of google.rpc.Code. + "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. + { + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + ], + "message": "A String", # 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. + }, + ], "analysisStatus": "A String", # The status of discovery for the resource. "analysisStatusError": { # 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). # When an error is encountered this will contain a LocalizedMessage under details to show to the user. The LocalizedMessage is output only and populated by the API. "code": 42, # The status code, which should be an enum value of google.rpc.Code. @@ -3067,6 +3163,22 @@

Method Details

}, "discovered": { # Details of a discovery occurrence. # Describes when a resource was discovered. "discovered": { # Provides information about the analysis status of a discovered resource. # Required. Analysis status for the discovered resource. + "analysisCompleted": { # Indicates which analysis completed successfully. Multiple types of analysis can be performed on a single resource. + "analysisType": [ + "A String", + ], + }, + "analysisError": [ # Indicates any errors encountered during analysis of a resource. There could be 0 or more of these errors. + { # 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). + "code": 42, # The status code, which should be an enum value of google.rpc.Code. + "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. + { + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + ], + "message": "A String", # 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. + }, + ], "analysisStatus": "A String", # The status of discovery for the resource. "analysisStatusError": { # 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). # When an error is encountered this will contain a LocalizedMessage under details to show to the user. The LocalizedMessage is output only and populated by the API. "code": 42, # The status code, which should be an enum value of google.rpc.Code. @@ -3460,6 +3572,22 @@

Method Details

}, "discovered": { # Details of a discovery occurrence. # Describes when a resource was discovered. "discovered": { # Provides information about the analysis status of a discovered resource. # Required. Analysis status for the discovered resource. + "analysisCompleted": { # Indicates which analysis completed successfully. Multiple types of analysis can be performed on a single resource. + "analysisType": [ + "A String", + ], + }, + "analysisError": [ # Indicates any errors encountered during analysis of a resource. There could be 0 or more of these errors. + { # 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). + "code": 42, # The status code, which should be an enum value of google.rpc.Code. + "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. + { + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + ], + "message": "A String", # 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. + }, + ], "analysisStatus": "A String", # The status of discovery for the resource. "analysisStatusError": { # 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). # When an error is encountered this will contain a LocalizedMessage under details to show to the user. The LocalizedMessage is output only and populated by the API. "code": 42, # The status code, which should be an enum value of google.rpc.Code. diff --git a/googleapiclient/discovery_cache/documents/containeranalysis.v1.json b/googleapiclient/discovery_cache/documents/containeranalysis.v1.json index cdf42b02045..b5369b5c180 100644 --- a/googleapiclient/discovery_cache/documents/containeranalysis.v1.json +++ b/googleapiclient/discovery_cache/documents/containeranalysis.v1.json @@ -755,7 +755,7 @@ } } }, - "revision": "20220624", + "revision": "20220707", "rootUrl": "https://containeranalysis.googleapis.com/", "schemas": { "AliasContext": { @@ -785,6 +785,19 @@ }, "type": "object" }, + "AnalysisCompleted": { + "description": "Indicates which analysis completed successfully. Multiple types of analysis can be performed on a single resource.", + "id": "AnalysisCompleted", + "properties": { + "analysisType": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "Artifact": { "description": "Artifact describes a build product.", "id": "Artifact", @@ -2710,6 +2723,16 @@ "description": "Provides information about the analysis status of a discovered resource.", "id": "DiscoveryOccurrence", "properties": { + "analysisCompleted": { + "$ref": "AnalysisCompleted" + }, + "analysisError": { + "description": "Indicates any errors encountered during analysis of a resource. There could be 0 or more of these errors.", + "items": { + "$ref": "Status" + }, + "type": "array" + }, "analysisStatus": { "description": "The status of discovery for the resource.", "enum": [ @@ -2717,6 +2740,7 @@ "PENDING", "SCANNING", "FINISHED_SUCCESS", + "COMPLETE", "FINISHED_FAILED", "FINISHED_UNSUPPORTED" ], @@ -2725,8 +2749,9 @@ "Resource is known but no action has been taken yet.", "Resource is being analyzed.", "Analysis has finished successfully.", + "Analysis has completed", "Analysis has finished unsuccessfully, the analysis itself is in a bad state.", - "The resource is known not to be supported" + "The resource is known not to be supported." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/containeranalysis.v1alpha1.json b/googleapiclient/discovery_cache/documents/containeranalysis.v1alpha1.json index bb588497ebc..b2e564540b7 100644 --- a/googleapiclient/discovery_cache/documents/containeranalysis.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/containeranalysis.v1alpha1.json @@ -1229,7 +1229,7 @@ } } }, - "revision": "20220624", + "revision": "20220707", "rootUrl": "https://containeranalysis.googleapis.com/", "schemas": { "Artifact": { @@ -1803,6 +1803,10 @@ "description": "Describes the CIS benchmark version that is applicable to a given OS and os version.", "id": "ComplianceVersion", "properties": { + "benchmarkDocument": { + "description": "The name of the document that defines this benchmark, e.g. \"CIS Container-Optimized OS\".", + "type": "string" + }, "cpeUri": { "description": "The CPE URI (https://cpe.mitre.org/specification/) this benchmark is applicable to.", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/containeranalysis.v1beta1.json b/googleapiclient/discovery_cache/documents/containeranalysis.v1beta1.json index 2fe8d85591b..5c2804fb5bd 100644 --- a/googleapiclient/discovery_cache/documents/containeranalysis.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/containeranalysis.v1beta1.json @@ -853,7 +853,7 @@ } } }, - "revision": "20220624", + "revision": "20220707", "rootUrl": "https://containeranalysis.googleapis.com/", "schemas": { "AliasContext": { @@ -883,6 +883,19 @@ }, "type": "object" }, + "AnalysisCompleted": { + "description": "Indicates which analysis completed successfully. Multiple types of analysis can be performed on a single resource.", + "id": "AnalysisCompleted", + "properties": { + "analysisType": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "Artifact": { "description": "Artifact describes a build product.", "id": "Artifact", @@ -2697,6 +2710,16 @@ "description": "Provides information about the analysis status of a discovered resource.", "id": "Discovered", "properties": { + "analysisCompleted": { + "$ref": "AnalysisCompleted" + }, + "analysisError": { + "description": "Indicates any errors encountered during analysis of a resource. There could be 0 or more of these errors.", + "items": { + "$ref": "Status" + }, + "type": "array" + }, "analysisStatus": { "description": "The status of discovery for the resource.", "enum": [ @@ -2704,6 +2727,7 @@ "PENDING", "SCANNING", "FINISHED_SUCCESS", + "COMPLETE", "FINISHED_FAILED", "FINISHED_UNSUPPORTED" ], @@ -2712,6 +2736,7 @@ "Resource is known but no action has been taken yet.", "Resource is being analyzed.", "Analysis has finished successfully.", + "Analysis has completed.", "Analysis has finished unsuccessfully, the analysis itself is in a bad state.", "The resource is known not to be supported" ], From 05688d8cef0aa5bf91024e48b614d84103f35565 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 19 Jul 2022 07:08:12 +0000 Subject: [PATCH 11/23] feat(content): update the api #### content:v2.1 The following keys were deleted: - resources.accountstatusesbyexternalsellerid.methods.get (Total Keys: 17) --- docs/dyn/content_v2_1.html | 5 --- .../documents/content.v2.1.json | 44 +------------------ 2 files changed, 1 insertion(+), 48 deletions(-) diff --git a/docs/dyn/content_v2_1.html b/docs/dyn/content_v2_1.html index 40f3f9d9a89..8d8660cd0fa 100644 --- a/docs/dyn/content_v2_1.html +++ b/docs/dyn/content_v2_1.html @@ -84,11 +84,6 @@

Instance Methods

Returns the accountstatuses Resource.

-

- accountstatusesbyexternalsellerid() -

-

Returns the accountstatusesbyexternalsellerid Resource.

-

accounttax()

diff --git a/googleapiclient/discovery_cache/documents/content.v2.1.json b/googleapiclient/discovery_cache/documents/content.v2.1.json index 09bf7594472..3484e26fc9c 100644 --- a/googleapiclient/discovery_cache/documents/content.v2.1.json +++ b/googleapiclient/discovery_cache/documents/content.v2.1.json @@ -973,48 +973,6 @@ } } }, - "accountstatusesbyexternalsellerid": { - "methods": { - "get": { - "description": "Gets status of the account with the specified external_seller_id belonging to the MCA with the specified merchant_id.", - "flatPath": "{merchantId}/accountstatusesbyexternalsellerid/{externalSellerId}", - "httpMethod": "GET", - "id": "content.accountstatusesbyexternalsellerid.get", - "parameterOrder": [ - "merchantId", - "externalSellerId" - ], - "parameters": { - "destinations": { - "description": "If set, only issues for the specified destinations are returned, otherwise only issues for the Shopping destination.", - "location": "query", - "repeated": true, - "type": "string" - }, - "externalSellerId": { - "description": "Required. The External Seller ID of the seller account to be retrieved.", - "location": "path", - "required": true, - "type": "string" - }, - "merchantId": { - "description": "Required. The ID of the MCA containing the seller.", - "format": "int64", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "{merchantId}/accountstatusesbyexternalsellerid/{externalSellerId}", - "response": { - "$ref": "AccountStatus" - }, - "scopes": [ - "https://www.googleapis.com/auth/content" - ] - } - } - }, "accounttax": { "methods": { "custombatch": { @@ -5950,7 +5908,7 @@ } } }, - "revision": "20220706", + "revision": "20220713", "rootUrl": "https://shoppingcontent.googleapis.com/", "schemas": { "Account": { From fc428158e1f9f98a7b3744087b66f4a9dc7f62a7 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 19 Jul 2022 07:08:12 +0000 Subject: [PATCH 12/23] feat(datacatalog): update the api #### datacatalog:v1 The following keys were added: - schemas.GoogleCloudDatacatalogV1ColumnSchema.properties.lookerColumnSpec.$ref (Total Keys: 1) - schemas.GoogleCloudDatacatalogV1ColumnSchemaLookerColumnSpec (Total Keys: 3) --- docs/dyn/datacatalog_v1.entries.html | 3 ++ ...rojects.locations.entryGroups.entries.html | 18 ++++++++++ .../documents/datacatalog.v1.json | 33 ++++++++++++++++++- .../documents/datacatalog.v1beta1.json | 2 +- 4 files changed, 54 insertions(+), 2 deletions(-) diff --git a/docs/dyn/datacatalog_v1.entries.html b/docs/dyn/datacatalog_v1.entries.html index f1bf56055e7..a9ae5b40b8c 100644 --- a/docs/dyn/datacatalog_v1.entries.html +++ b/docs/dyn/datacatalog_v1.entries.html @@ -267,6 +267,9 @@

Method Details

{ # A column within a schema. Columns can be nested inside other columns. "column": "A String", # Required. Name of the column. Must be a UTF-8 string without dots (.). The maximum size is 64 bytes. "description": "A String", # Optional. Description of the column. Default value is an empty string. The description must be a UTF-8 string with the maximum size of 2000 bytes. + "lookerColumnSpec": { # Column info specific to Looker System. # Looker specific column info of this column. + "type": "A String", # Looker specific column type of this column. + }, "mode": "A String", # Optional. A column's mode indicates whether values in this column are required, nullable, or repeated. Only `NULLABLE`, `REQUIRED`, and `REPEATED` values are supported. Default mode is `NULLABLE`. "subcolumns": [ # Optional. Schema of sub-columns. A column can have zero or more sub-columns. # Object with schema name: GoogleCloudDatacatalogV1ColumnSchema diff --git a/docs/dyn/datacatalog_v1.projects.locations.entryGroups.entries.html b/docs/dyn/datacatalog_v1.projects.locations.entryGroups.entries.html index 45acdc8383d..423d390d37d 100644 --- a/docs/dyn/datacatalog_v1.projects.locations.entryGroups.entries.html +++ b/docs/dyn/datacatalog_v1.projects.locations.entryGroups.entries.html @@ -298,6 +298,9 @@

Method Details

{ # A column within a schema. Columns can be nested inside other columns. "column": "A String", # Required. Name of the column. Must be a UTF-8 string without dots (.). The maximum size is 64 bytes. "description": "A String", # Optional. Description of the column. Default value is an empty string. The description must be a UTF-8 string with the maximum size of 2000 bytes. + "lookerColumnSpec": { # Column info specific to Looker System. # Looker specific column info of this column. + "type": "A String", # Looker specific column type of this column. + }, "mode": "A String", # Optional. A column's mode indicates whether values in this column are required, nullable, or repeated. Only `NULLABLE`, `REQUIRED`, and `REPEATED` values are supported. Default mode is `NULLABLE`. "subcolumns": [ # Optional. Schema of sub-columns. A column can have zero or more sub-columns. # Object with schema name: GoogleCloudDatacatalogV1ColumnSchema @@ -501,6 +504,9 @@

Method Details

{ # A column within a schema. Columns can be nested inside other columns. "column": "A String", # Required. Name of the column. Must be a UTF-8 string without dots (.). The maximum size is 64 bytes. "description": "A String", # Optional. Description of the column. Default value is an empty string. The description must be a UTF-8 string with the maximum size of 2000 bytes. + "lookerColumnSpec": { # Column info specific to Looker System. # Looker specific column info of this column. + "type": "A String", # Looker specific column type of this column. + }, "mode": "A String", # Optional. A column's mode indicates whether values in this column are required, nullable, or repeated. Only `NULLABLE`, `REQUIRED`, and `REPEATED` values are supported. Default mode is `NULLABLE`. "subcolumns": [ # Optional. Schema of sub-columns. A column can have zero or more sub-columns. # Object with schema name: GoogleCloudDatacatalogV1ColumnSchema @@ -728,6 +734,9 @@

Method Details

{ # A column within a schema. Columns can be nested inside other columns. "column": "A String", # Required. Name of the column. Must be a UTF-8 string without dots (.). The maximum size is 64 bytes. "description": "A String", # Optional. Description of the column. Default value is an empty string. The description must be a UTF-8 string with the maximum size of 2000 bytes. + "lookerColumnSpec": { # Column info specific to Looker System. # Looker specific column info of this column. + "type": "A String", # Looker specific column type of this column. + }, "mode": "A String", # Optional. A column's mode indicates whether values in this column are required, nullable, or repeated. Only `NULLABLE`, `REQUIRED`, and `REPEATED` values are supported. Default mode is `NULLABLE`. "subcolumns": [ # Optional. Schema of sub-columns. A column can have zero or more sub-columns. # Object with schema name: GoogleCloudDatacatalogV1ColumnSchema @@ -985,6 +994,9 @@

Method Details

{ # A column within a schema. Columns can be nested inside other columns. "column": "A String", # Required. Name of the column. Must be a UTF-8 string without dots (.). The maximum size is 64 bytes. "description": "A String", # Optional. Description of the column. Default value is an empty string. The description must be a UTF-8 string with the maximum size of 2000 bytes. + "lookerColumnSpec": { # Column info specific to Looker System. # Looker specific column info of this column. + "type": "A String", # Looker specific column type of this column. + }, "mode": "A String", # Optional. A column's mode indicates whether values in this column are required, nullable, or repeated. Only `NULLABLE`, `REQUIRED`, and `REPEATED` values are supported. Default mode is `NULLABLE`. "subcolumns": [ # Optional. Schema of sub-columns. A column can have zero or more sub-columns. # Object with schema name: GoogleCloudDatacatalogV1ColumnSchema @@ -1272,6 +1284,9 @@

Method Details

{ # A column within a schema. Columns can be nested inside other columns. "column": "A String", # Required. Name of the column. Must be a UTF-8 string without dots (.). The maximum size is 64 bytes. "description": "A String", # Optional. Description of the column. Default value is an empty string. The description must be a UTF-8 string with the maximum size of 2000 bytes. + "lookerColumnSpec": { # Column info specific to Looker System. # Looker specific column info of this column. + "type": "A String", # Looker specific column type of this column. + }, "mode": "A String", # Optional. A column's mode indicates whether values in this column are required, nullable, or repeated. Only `NULLABLE`, `REQUIRED`, and `REPEATED` values are supported. Default mode is `NULLABLE`. "subcolumns": [ # Optional. Schema of sub-columns. A column can have zero or more sub-columns. # Object with schema name: GoogleCloudDatacatalogV1ColumnSchema @@ -1475,6 +1490,9 @@

Method Details

{ # A column within a schema. Columns can be nested inside other columns. "column": "A String", # Required. Name of the column. Must be a UTF-8 string without dots (.). The maximum size is 64 bytes. "description": "A String", # Optional. Description of the column. Default value is an empty string. The description must be a UTF-8 string with the maximum size of 2000 bytes. + "lookerColumnSpec": { # Column info specific to Looker System. # Looker specific column info of this column. + "type": "A String", # Looker specific column type of this column. + }, "mode": "A String", # Optional. A column's mode indicates whether values in this column are required, nullable, or repeated. Only `NULLABLE`, `REQUIRED`, and `REPEATED` values are supported. Default mode is `NULLABLE`. "subcolumns": [ # Optional. Schema of sub-columns. A column can have zero or more sub-columns. # Object with schema name: GoogleCloudDatacatalogV1ColumnSchema diff --git a/googleapiclient/discovery_cache/documents/datacatalog.v1.json b/googleapiclient/discovery_cache/documents/datacatalog.v1.json index 020c99de27a..f330d5e79ac 100644 --- a/googleapiclient/discovery_cache/documents/datacatalog.v1.json +++ b/googleapiclient/discovery_cache/documents/datacatalog.v1.json @@ -1953,7 +1953,7 @@ } } }, - "revision": "20220624", + "revision": "20220707", "rootUrl": "https://datacatalog.googleapis.com/", "schemas": { "Binding": { @@ -2187,6 +2187,10 @@ "description": "Optional. Description of the column. Default value is an empty string. The description must be a UTF-8 string with the maximum size of 2000 bytes.", "type": "string" }, + "lookerColumnSpec": { + "$ref": "GoogleCloudDatacatalogV1ColumnSchemaLookerColumnSpec", + "description": "Looker specific column info of this column." + }, "mode": { "description": "Optional. A column's mode indicates whether values in this column are required, nullable, or repeated. Only `NULLABLE`, `REQUIRED`, and `REPEATED` values are supported. Default mode is `NULLABLE`.", "type": "string" @@ -2205,6 +2209,33 @@ }, "type": "object" }, + "GoogleCloudDatacatalogV1ColumnSchemaLookerColumnSpec": { + "description": "Column info specific to Looker System.", + "id": "GoogleCloudDatacatalogV1ColumnSchemaLookerColumnSpec", + "properties": { + "type": { + "description": "Looker specific column type of this column.", + "enum": [ + "LOOKER_COLUMN_TYPE_UNSPECIFIED", + "DIMENSION", + "DIMENSION_GROUP", + "FILTER", + "MEASURE", + "PAREMETER" + ], + "enumDescriptions": [ + "Unspecified.", + "Dimension.", + "Dimension group - parent for Dimension.", + "Filter.", + "Measure.", + "Parameter." + ], + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDatacatalogV1Contacts": { "description": "Contact people for the entry.", "id": "GoogleCloudDatacatalogV1Contacts", diff --git a/googleapiclient/discovery_cache/documents/datacatalog.v1beta1.json b/googleapiclient/discovery_cache/documents/datacatalog.v1beta1.json index 263fe07f19d..0e066943b20 100644 --- a/googleapiclient/discovery_cache/documents/datacatalog.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/datacatalog.v1beta1.json @@ -1808,7 +1808,7 @@ } } }, - "revision": "20220624", + "revision": "20220707", "rootUrl": "https://datacatalog.googleapis.com/", "schemas": { "Binding": { From 24b6a0e825f3f4f6e97bd9cff731d137c6a235a3 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 19 Jul 2022 07:08:12 +0000 Subject: [PATCH 13/23] feat(dataplex): update the api #### dataplex:v1 The following keys were added: - schemas.GoogleCloudDataplexV1TaskExecutionSpec.properties.kmsKey.type (Total Keys: 1) - schemas.GoogleCloudDataplexV1TaskInfrastructureSpecContainerImageRuntime.properties.image.type (Total Keys: 1) --- ...x_v1.projects.locations.lakes.actions.html | 2 +- ...projects.locations.lakes.environments.html | 8 +-- ...locations.lakes.environments.sessions.html | 2 +- .../dataplex_v1.projects.locations.lakes.html | 4 +- ...lex_v1.projects.locations.lakes.tasks.html | 32 ++++++---- ...1.projects.locations.lakes.tasks.jobs.html | 14 ++-- ...rojects.locations.lakes.zones.actions.html | 2 +- ....locations.lakes.zones.assets.actions.html | 2 +- ...projects.locations.lakes.zones.assets.html | 8 +-- ...lex_v1.projects.locations.lakes.zones.html | 8 +-- .../documents/dataplex.v1.json | 64 +++++++++++-------- 11 files changed, 81 insertions(+), 65 deletions(-) diff --git a/docs/dyn/dataplex_v1.projects.locations.lakes.actions.html b/docs/dyn/dataplex_v1.projects.locations.lakes.actions.html index 6a27481d226..64b1872f2dc 100644 --- a/docs/dyn/dataplex_v1.projects.locations.lakes.actions.html +++ b/docs/dyn/dataplex_v1.projects.locations.lakes.actions.html @@ -94,7 +94,7 @@

Method Details

Lists action resources in a lake.
 
 Args:
-  parent: string, Required. The resource name of the parent lake: projects/{project_number}/locations/{location_id}/lakes/{lake_id} (required)
+  parent: string, Required. The resource name of the parent lake: projects/{project_number}/locations/{location_id}/lakes/{lake_id}. (required)
   pageSize: integer, Optional. Maximum number of actions to return. The service may return fewer than this value. If unspecified, at most 10 actions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
   pageToken: string, Optional. Page token received from a previous ListLakeActions call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListLakeActions must match the call that provided the page token.
   x__xgafv: string, V1 error format.
diff --git a/docs/dyn/dataplex_v1.projects.locations.lakes.environments.html b/docs/dyn/dataplex_v1.projects.locations.lakes.environments.html
index fde352f452e..a0534fc4a7f 100644
--- a/docs/dyn/dataplex_v1.projects.locations.lakes.environments.html
+++ b/docs/dyn/dataplex_v1.projects.locations.lakes.environments.html
@@ -120,7 +120,7 @@ 

Method Details

Create an environment resource.
 
 Args:
-  parent: string, Required. The resource name of the parent lake: projects/{project_id}/locations/{location_id}/lakes/{lake_id} (required)
+  parent: string, Required. The resource name of the parent lake: projects/{project_id}/locations/{location_id}/lakes/{lake_id}. (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -203,7 +203,7 @@ 

Method Details

Delete the environment resource. All the child resources must have been deleted before environment deletion can be initiated.
 
 Args:
-  name: string, Required. The resource name of the environment: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/environments/{environment_id}` (required)
+  name: string, Required. The resource name of the environment: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/environments/{environment_id}. (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -238,7 +238,7 @@ 

Method Details

Get environment resource.
 
 Args:
-  name: string, Required. The resource name of the environment: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/environments/{environment_id} (required)
+  name: string, Required. The resource name of the environment: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/environments/{environment_id}. (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -344,7 +344,7 @@ 

Method Details

Lists environments under the given lake.
 
 Args:
-  parent: string, Required. The resource name of the parent lake: projects/{project_id}/locations/{location_id}/lakes/{lake_id} (required)
+  parent: string, Required. The resource name of the parent lake: projects/{project_id}/locations/{location_id}/lakes/{lake_id}. (required)
   filter: string, Optional. Filter request.
   orderBy: string, Optional. Order by fields for the result.
   pageSize: integer, Optional. Maximum number of environments to return. The service may return fewer than this value. If unspecified, at most 10 environments will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
diff --git a/docs/dyn/dataplex_v1.projects.locations.lakes.environments.sessions.html b/docs/dyn/dataplex_v1.projects.locations.lakes.environments.sessions.html
index bbcedf4f97c..3637e0987cd 100644
--- a/docs/dyn/dataplex_v1.projects.locations.lakes.environments.sessions.html
+++ b/docs/dyn/dataplex_v1.projects.locations.lakes.environments.sessions.html
@@ -94,7 +94,7 @@ 

Method Details

Lists session resources in an environment.
 
 Args:
-  parent: string, Required. The resource name of the parent environment: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/environment/{environment_id} (required)
+  parent: string, Required. The resource name of the parent environment: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/environment/{environment_id}. (required)
   filter: string, Optional. Filter request. The following mode filter is supported to return only the sessions belonging to the requester when the mode is USER and return sessions of all the users when the mode is ADMIN. When no filter is sent default to USER mode. NOTE: When the mode is ADMIN, the requester should have dataplex.environments.listAllSessions permission to list all sessions, in absence of the permission, the request fails.mode = ADMIN | USER
   pageSize: integer, Optional. Maximum number of sessions to return. The service may return fewer than this value. If unspecified, at most 10 sessions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
   pageToken: string, Optional. Page token received from a previous ListSessions call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListSessions must match the call that provided the page token.
diff --git a/docs/dyn/dataplex_v1.projects.locations.lakes.html b/docs/dyn/dataplex_v1.projects.locations.lakes.html
index 7470a3eeac5..6b76aca4db6 100644
--- a/docs/dyn/dataplex_v1.projects.locations.lakes.html
+++ b/docs/dyn/dataplex_v1.projects.locations.lakes.html
@@ -213,7 +213,7 @@ 

Method Details

Deletes a lake resource. All zones within the lake must be deleted before the lake can be deleted.
 
 Args:
-  name: string, Required. The resource name of the lake: projects/{project_number}/locations/{location_id}/lakes/{lake_id} (required)
+  name: string, Required. The resource name of the lake: projects/{project_number}/locations/{location_id}/lakes/{lake_id}. (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -248,7 +248,7 @@ 

Method Details

Retrieves a lake resource.
 
 Args:
-  name: string, Required. The resource name of the lake: projects/{project_number}/locations/{location_id}/lakes/{lake_id} (required)
+  name: string, Required. The resource name of the lake: projects/{project_number}/locations/{location_id}/lakes/{lake_id}. (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
diff --git a/docs/dyn/dataplex_v1.projects.locations.lakes.tasks.html b/docs/dyn/dataplex_v1.projects.locations.lakes.tasks.html
index 10b1f6000aa..42504674de5 100644
--- a/docs/dyn/dataplex_v1.projects.locations.lakes.tasks.html
+++ b/docs/dyn/dataplex_v1.projects.locations.lakes.tasks.html
@@ -120,7 +120,7 @@ 

Method Details

Creates a task resource within a lake.
 
 Args:
-  parent: string, Required. The resource name of the parent lake: projects/{project_number}/locations/{location_id}/lakes/{lake_id} (required)
+  parent: string, Required. The resource name of the parent lake: projects/{project_number}/locations/{location_id}/lakes/{lake_id}. (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -132,6 +132,7 @@ 

Method Details

"args": { # Optional. The arguments to pass to the task. The args can use placeholders of the format ${placeholder} as part of key/value string. These will be interpolated before passing the args to the driver. Currently supported placeholders: - ${task_id} - ${job_time} To pass positional args, set the key as TASK_ARGS. The value should be a comma-separated string of all the positional arguments. To use a delimiter other than comma, refer to https://cloud.google.com/sdk/gcloud/reference/topic/escaping. In case of other keys being present in the args, then TASK_ARGS will be passed as the last argument. "a_key": "A String", }, + "kmsKey": "A String", # Optional. The Cloud KMS key to use for encryption, of the form: projects/{project_number}/locations/{location_id}/keyRings/{key-ring-name}/cryptoKeys/{key-name}. "maxJobExecutionLifetime": "A String", # Optional. The maximum duration after which the job execution is expired. "project": "A String", # Optional. The project in which jobs are run. By default, the project containing the Lake is used. If a project is provided, the executionspec.service_account must belong to this same project. "serviceAccount": "A String", # Required. Service account to use to execute a task. If not provided, the default Compute service account for the project is used. @@ -140,8 +141,8 @@

Method Details

"latestJob": { # A job represents an instance of a task. # Output only. latest job execution "endTime": "A String", # Output only. The time when the job ended. "message": "A String", # Output only. Additional information about the current state. - "name": "A String", # Output only. The relative resource name of the job, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/ tasks/{task_id}/jobs/{job_id}. - "retryCount": 42, # Output only. . The number of times the job has been retried (excluding the initial attempt). + "name": "A String", # Output only. The relative resource name of the job, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/tasks/{task_id}/jobs/{job_id}. + "retryCount": 42, # Output only. The number of times the job has been retried (excluding the initial attempt). "service": "A String", # Output only. The underlying service running a job. "serviceJob": "A String", # Output only. The full resource name for the job run under a particular service. "startTime": "A String", # Output only. The time when the job was started. @@ -167,6 +168,7 @@

Method Details

"maxExecutorsCount": 42, # Optional. Max configurable executors. If max_executors_count > executors_count, then auto-scaling is enabled. Max Executor Count should be between 2 and 1000. Default=1000 }, "containerImage": { # Container Image Runtime Configuration used with Batch execution. # Container Image Runtime Configuration. + "image": "A String", # Optional. Container image to use. "javaJars": [ # Optional. A list of Java JARS to add to the classpath. Valid input includes Cloud Storage URIs to Jar binaries. For example, gs://bucket-name/my/path/to/file.jar "A String", ], @@ -239,7 +241,7 @@

Method Details

Delete the task resource.
 
 Args:
-  name: string, Required. The resource name of the task: projects/{project_number}/locations/{location_id}/lakes/{lake_id} /task/{task_id}` (required)
+  name: string, Required. The resource name of the task: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/task/{task_id}. (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -274,7 +276,7 @@ 

Method Details

Get task resource.
 
 Args:
-  name: string, Required. The resource name of the task: projects/{project_number}/locations/{location_id}/lakes/{lake_id} /tasks/{tasks_id} (required)
+  name: string, Required. The resource name of the task: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/tasks/{tasks_id}. (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -291,6 +293,7 @@ 

Method Details

"args": { # Optional. The arguments to pass to the task. The args can use placeholders of the format ${placeholder} as part of key/value string. These will be interpolated before passing the args to the driver. Currently supported placeholders: - ${task_id} - ${job_time} To pass positional args, set the key as TASK_ARGS. The value should be a comma-separated string of all the positional arguments. To use a delimiter other than comma, refer to https://cloud.google.com/sdk/gcloud/reference/topic/escaping. In case of other keys being present in the args, then TASK_ARGS will be passed as the last argument. "a_key": "A String", }, + "kmsKey": "A String", # Optional. The Cloud KMS key to use for encryption, of the form: projects/{project_number}/locations/{location_id}/keyRings/{key-ring-name}/cryptoKeys/{key-name}. "maxJobExecutionLifetime": "A String", # Optional. The maximum duration after which the job execution is expired. "project": "A String", # Optional. The project in which jobs are run. By default, the project containing the Lake is used. If a project is provided, the executionspec.service_account must belong to this same project. "serviceAccount": "A String", # Required. Service account to use to execute a task. If not provided, the default Compute service account for the project is used. @@ -299,8 +302,8 @@

Method Details

"latestJob": { # A job represents an instance of a task. # Output only. latest job execution "endTime": "A String", # Output only. The time when the job ended. "message": "A String", # Output only. Additional information about the current state. - "name": "A String", # Output only. The relative resource name of the job, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/ tasks/{task_id}/jobs/{job_id}. - "retryCount": 42, # Output only. . The number of times the job has been retried (excluding the initial attempt). + "name": "A String", # Output only. The relative resource name of the job, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/tasks/{task_id}/jobs/{job_id}. + "retryCount": 42, # Output only. The number of times the job has been retried (excluding the initial attempt). "service": "A String", # Output only. The underlying service running a job. "serviceJob": "A String", # Output only. The full resource name for the job run under a particular service. "startTime": "A String", # Output only. The time when the job was started. @@ -326,6 +329,7 @@

Method Details

"maxExecutorsCount": 42, # Optional. Max configurable executors. If max_executors_count > executors_count, then auto-scaling is enabled. Max Executor Count should be between 2 and 1000. Default=1000 }, "containerImage": { # Container Image Runtime Configuration used with Batch execution. # Container Image Runtime Configuration. + "image": "A String", # Optional. Container image to use. "javaJars": [ # Optional. A list of Java JARS to add to the classpath. Valid input includes Cloud Storage URIs to Jar binaries. For example, gs://bucket-name/my/path/to/file.jar "A String", ], @@ -416,7 +420,7 @@

Method Details

Lists tasks under the given lake.
 
 Args:
-  parent: string, Required. The resource name of the parent lake: projects/{project_number}/locations/{location_id}/lakes/{lake_id} (required)
+  parent: string, Required. The resource name of the parent lake: projects/{project_number}/locations/{location_id}/lakes/{lake_id}. (required)
   filter: string, Optional. Filter request.
   orderBy: string, Optional. Order by fields for the result.
   pageSize: integer, Optional. Maximum number of tasks to return. The service may return fewer than this value. If unspecified, at most 10 tasks will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
@@ -440,6 +444,7 @@ 

Method Details

"args": { # Optional. The arguments to pass to the task. The args can use placeholders of the format ${placeholder} as part of key/value string. These will be interpolated before passing the args to the driver. Currently supported placeholders: - ${task_id} - ${job_time} To pass positional args, set the key as TASK_ARGS. The value should be a comma-separated string of all the positional arguments. To use a delimiter other than comma, refer to https://cloud.google.com/sdk/gcloud/reference/topic/escaping. In case of other keys being present in the args, then TASK_ARGS will be passed as the last argument. "a_key": "A String", }, + "kmsKey": "A String", # Optional. The Cloud KMS key to use for encryption, of the form: projects/{project_number}/locations/{location_id}/keyRings/{key-ring-name}/cryptoKeys/{key-name}. "maxJobExecutionLifetime": "A String", # Optional. The maximum duration after which the job execution is expired. "project": "A String", # Optional. The project in which jobs are run. By default, the project containing the Lake is used. If a project is provided, the executionspec.service_account must belong to this same project. "serviceAccount": "A String", # Required. Service account to use to execute a task. If not provided, the default Compute service account for the project is used. @@ -448,8 +453,8 @@

Method Details

"latestJob": { # A job represents an instance of a task. # Output only. latest job execution "endTime": "A String", # Output only. The time when the job ended. "message": "A String", # Output only. Additional information about the current state. - "name": "A String", # Output only. The relative resource name of the job, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/ tasks/{task_id}/jobs/{job_id}. - "retryCount": 42, # Output only. . The number of times the job has been retried (excluding the initial attempt). + "name": "A String", # Output only. The relative resource name of the job, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/tasks/{task_id}/jobs/{job_id}. + "retryCount": 42, # Output only. The number of times the job has been retried (excluding the initial attempt). "service": "A String", # Output only. The underlying service running a job. "serviceJob": "A String", # Output only. The full resource name for the job run under a particular service. "startTime": "A String", # Output only. The time when the job was started. @@ -475,6 +480,7 @@

Method Details

"maxExecutorsCount": 42, # Optional. Max configurable executors. If max_executors_count > executors_count, then auto-scaling is enabled. Max Executor Count should be between 2 and 1000. Default=1000 }, "containerImage": { # Container Image Runtime Configuration used with Batch execution. # Container Image Runtime Configuration. + "image": "A String", # Optional. Container image to use. "javaJars": [ # Optional. A list of Java JARS to add to the classpath. Valid input includes Cloud Storage URIs to Jar binaries. For example, gs://bucket-name/my/path/to/file.jar "A String", ], @@ -548,6 +554,7 @@

Method Details

"args": { # Optional. The arguments to pass to the task. The args can use placeholders of the format ${placeholder} as part of key/value string. These will be interpolated before passing the args to the driver. Currently supported placeholders: - ${task_id} - ${job_time} To pass positional args, set the key as TASK_ARGS. The value should be a comma-separated string of all the positional arguments. To use a delimiter other than comma, refer to https://cloud.google.com/sdk/gcloud/reference/topic/escaping. In case of other keys being present in the args, then TASK_ARGS will be passed as the last argument. "a_key": "A String", }, + "kmsKey": "A String", # Optional. The Cloud KMS key to use for encryption, of the form: projects/{project_number}/locations/{location_id}/keyRings/{key-ring-name}/cryptoKeys/{key-name}. "maxJobExecutionLifetime": "A String", # Optional. The maximum duration after which the job execution is expired. "project": "A String", # Optional. The project in which jobs are run. By default, the project containing the Lake is used. If a project is provided, the executionspec.service_account must belong to this same project. "serviceAccount": "A String", # Required. Service account to use to execute a task. If not provided, the default Compute service account for the project is used. @@ -556,8 +563,8 @@

Method Details

"latestJob": { # A job represents an instance of a task. # Output only. latest job execution "endTime": "A String", # Output only. The time when the job ended. "message": "A String", # Output only. Additional information about the current state. - "name": "A String", # Output only. The relative resource name of the job, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/ tasks/{task_id}/jobs/{job_id}. - "retryCount": 42, # Output only. . The number of times the job has been retried (excluding the initial attempt). + "name": "A String", # Output only. The relative resource name of the job, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/tasks/{task_id}/jobs/{job_id}. + "retryCount": 42, # Output only. The number of times the job has been retried (excluding the initial attempt). "service": "A String", # Output only. The underlying service running a job. "serviceJob": "A String", # Output only. The full resource name for the job run under a particular service. "startTime": "A String", # Output only. The time when the job was started. @@ -583,6 +590,7 @@

Method Details

"maxExecutorsCount": 42, # Optional. Max configurable executors. If max_executors_count > executors_count, then auto-scaling is enabled. Max Executor Count should be between 2 and 1000. Default=1000 }, "containerImage": { # Container Image Runtime Configuration used with Batch execution. # Container Image Runtime Configuration. + "image": "A String", # Optional. Container image to use. "javaJars": [ # Optional. A list of Java JARS to add to the classpath. Valid input includes Cloud Storage URIs to Jar binaries. For example, gs://bucket-name/my/path/to/file.jar "A String", ], diff --git a/docs/dyn/dataplex_v1.projects.locations.lakes.tasks.jobs.html b/docs/dyn/dataplex_v1.projects.locations.lakes.tasks.jobs.html index 0894a29b6f7..a152250542a 100644 --- a/docs/dyn/dataplex_v1.projects.locations.lakes.tasks.jobs.html +++ b/docs/dyn/dataplex_v1.projects.locations.lakes.tasks.jobs.html @@ -95,7 +95,7 @@

Method Details

Cancel jobs running for the task resource.
 
 Args:
-  name: string, Required. The resource name of the job: projects/{project_number}/locations/{location_id}/lakes/{lake_id} /task/{task_id}/job/{job_id}` (required)
+  name: string, Required. The resource name of the job: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/task/{task_id}/job/{job_id}. (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -124,7 +124,7 @@ 

Method Details

Get job resource.
 
 Args:
-  name: string, Required. The resource name of the job: projects/{project_number}/locations/{location_id}/lakes/{lake_id} /tasks/{task_id}/jobs/{job_id} (required)
+  name: string, Required. The resource name of the job: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/tasks/{task_id}/jobs/{job_id}. (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -136,8 +136,8 @@ 

Method Details

{ # A job represents an instance of a task. "endTime": "A String", # Output only. The time when the job ended. "message": "A String", # Output only. Additional information about the current state. - "name": "A String", # Output only. The relative resource name of the job, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/ tasks/{task_id}/jobs/{job_id}. - "retryCount": 42, # Output only. . The number of times the job has been retried (excluding the initial attempt). + "name": "A String", # Output only. The relative resource name of the job, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/tasks/{task_id}/jobs/{job_id}. + "retryCount": 42, # Output only. The number of times the job has been retried (excluding the initial attempt). "service": "A String", # Output only. The underlying service running a job. "serviceJob": "A String", # Output only. The full resource name for the job run under a particular service. "startTime": "A String", # Output only. The time when the job was started. @@ -151,7 +151,7 @@

Method Details

Lists Jobs under the given task.
 
 Args:
-  parent: string, Required. The resource name of the parent environment: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/tasks/{task_id} (required)
+  parent: string, Required. The resource name of the parent environment: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/tasks/{task_id}. (required)
   pageSize: integer, Optional. Maximum number of jobs to return. The service may return fewer than this value. If unspecified, at most 10 jobs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
   pageToken: string, Optional. Page token received from a previous ListJobs call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListJobs must match the call that provided the page token.
   x__xgafv: string, V1 error format.
@@ -167,8 +167,8 @@ 

Method Details

{ # A job represents an instance of a task. "endTime": "A String", # Output only. The time when the job ended. "message": "A String", # Output only. Additional information about the current state. - "name": "A String", # Output only. The relative resource name of the job, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/ tasks/{task_id}/jobs/{job_id}. - "retryCount": 42, # Output only. . The number of times the job has been retried (excluding the initial attempt). + "name": "A String", # Output only. The relative resource name of the job, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/tasks/{task_id}/jobs/{job_id}. + "retryCount": 42, # Output only. The number of times the job has been retried (excluding the initial attempt). "service": "A String", # Output only. The underlying service running a job. "serviceJob": "A String", # Output only. The full resource name for the job run under a particular service. "startTime": "A String", # Output only. The time when the job was started. diff --git a/docs/dyn/dataplex_v1.projects.locations.lakes.zones.actions.html b/docs/dyn/dataplex_v1.projects.locations.lakes.zones.actions.html index a4d26eff411..c5b36f903f9 100644 --- a/docs/dyn/dataplex_v1.projects.locations.lakes.zones.actions.html +++ b/docs/dyn/dataplex_v1.projects.locations.lakes.zones.actions.html @@ -94,7 +94,7 @@

Method Details

Lists action resources in a zone.
 
 Args:
-  parent: string, Required. The resource name of the parent zone: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id} (required)
+  parent: string, Required. The resource name of the parent zone: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}. (required)
   pageSize: integer, Optional. Maximum number of actions to return. The service may return fewer than this value. If unspecified, at most 10 actions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
   pageToken: string, Optional. Page token received from a previous ListZoneActions call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListZoneActions must match the call that provided the page token.
   x__xgafv: string, V1 error format.
diff --git a/docs/dyn/dataplex_v1.projects.locations.lakes.zones.assets.actions.html b/docs/dyn/dataplex_v1.projects.locations.lakes.zones.assets.actions.html
index aebe6ab80ea..f34dd527ad7 100644
--- a/docs/dyn/dataplex_v1.projects.locations.lakes.zones.assets.actions.html
+++ b/docs/dyn/dataplex_v1.projects.locations.lakes.zones.assets.actions.html
@@ -94,7 +94,7 @@ 

Method Details

Lists action resources in an asset.
 
 Args:
-  parent: string, Required. The resource name of the parent asset: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/assets/{asset_id} (required)
+  parent: string, Required. The resource name of the parent asset: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/assets/{asset_id}. (required)
   pageSize: integer, Optional. Maximum number of actions to return. The service may return fewer than this value. If unspecified, at most 10 actions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
   pageToken: string, Optional. Page token received from a previous ListAssetActions call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAssetActions must match the call that provided the page token.
   x__xgafv: string, V1 error format.
diff --git a/docs/dyn/dataplex_v1.projects.locations.lakes.zones.assets.html b/docs/dyn/dataplex_v1.projects.locations.lakes.zones.assets.html
index d8d843475a9..4c888152871 100644
--- a/docs/dyn/dataplex_v1.projects.locations.lakes.zones.assets.html
+++ b/docs/dyn/dataplex_v1.projects.locations.lakes.zones.assets.html
@@ -120,7 +120,7 @@ 

Method Details

Creates an asset resource.
 
 Args:
-  parent: string, Required. The resource name of the parent zone: projects/{project_number}/locations/{location_id}/lakes/{lake_id} /zones/{zone_id}` (required)
+  parent: string, Required. The resource name of the parent zone: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}. (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -220,7 +220,7 @@ 

Method Details

Deletes an asset resource. The referenced storage resource is detached (default) or deleted based on the associated Lifecycle policy.
 
 Args:
-  name: string, Required. The resource name of the asset: projects/{project_number}/locations/{location_id}/lakes/{lake_id} /zones/{zone_id}/assets/{asset_id} (required)
+  name: string, Required. The resource name of the asset: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/assets/{asset_id}. (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -255,7 +255,7 @@ 

Method Details

Retrieves an asset resource.
 
 Args:
-  name: string, Required. The resource name of the asset: projects/{project_number}/locations/{location_id}/lakes/{lake_id} /zones/{zone_id}/assets/{asset_id} (required)
+  name: string, Required. The resource name of the asset: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/assets/{asset_id}. (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -378,7 +378,7 @@ 

Method Details

Lists asset resources in a zone.
 
 Args:
-  parent: string, Required. The resource name of the parent zone: projects/{project_number}/locations/{location_id}/lakes/{lake_id} /zones/{zone_id}` (required)
+  parent: string, Required. The resource name of the parent zone: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}. (required)
   filter: string, Optional. Filter request.
   orderBy: string, Optional. Order by fields for the result.
   pageSize: integer, Optional. Maximum number of asset to return. The service may return fewer than this value. If unspecified, at most 10 assets will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
diff --git a/docs/dyn/dataplex_v1.projects.locations.lakes.zones.html b/docs/dyn/dataplex_v1.projects.locations.lakes.zones.html
index 289dcf22b5f..e433eeda46c 100644
--- a/docs/dyn/dataplex_v1.projects.locations.lakes.zones.html
+++ b/docs/dyn/dataplex_v1.projects.locations.lakes.zones.html
@@ -130,7 +130,7 @@ 

Method Details

Creates a zone resource within a lake.
 
 Args:
-  parent: string, Required. The resource name of the parent lake: projects/{project_number}/locations/{location_id}/lakes/{lake_id} (required)
+  parent: string, Required. The resource name of the parent lake: projects/{project_number}/locations/{location_id}/lakes/{lake_id}. (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -212,7 +212,7 @@ 

Method Details

Deletes a zone resource. All assets within a zone must be deleted before the zone can be deleted.
 
 Args:
-  name: string, Required. The resource name of the zone: projects/{project_number}/locations/{location_id}/lakes/{lake_id} /zones/{zone_id}` (required)
+  name: string, Required. The resource name of the zone: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}. (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -247,7 +247,7 @@ 

Method Details

Retrieves a zone resource.
 
 Args:
-  name: string, Required. The resource name of the zone: projects/{project_number}/locations/{location_id}/lakes/{lake_id} /zones/{zone_id} (required)
+  name: string, Required. The resource name of the zone: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}. (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -352,7 +352,7 @@ 

Method Details

Lists zone resources in a lake.
 
 Args:
-  parent: string, Required. The resource name of the parent lake: projects/{project_number}/locations/{location_id}/lakes/{lake_id} (required)
+  parent: string, Required. The resource name of the parent lake: projects/{project_number}/locations/{location_id}/lakes/{lake_id}. (required)
   filter: string, Optional. Filter request.
   orderBy: string, Optional. Order by fields for the result.
   pageSize: integer, Optional. Maximum number of zones to return. The service may return fewer than this value. If unspecified, at most 10 zones will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
diff --git a/googleapiclient/discovery_cache/documents/dataplex.v1.json b/googleapiclient/discovery_cache/documents/dataplex.v1.json
index f69a7a650fc..9b95f5ae6ce 100644
--- a/googleapiclient/discovery_cache/documents/dataplex.v1.json
+++ b/googleapiclient/discovery_cache/documents/dataplex.v1.json
@@ -227,7 +227,7 @@
                   ],
                   "parameters": {
                     "name": {
-                      "description": "Required. The resource name of the lake: projects/{project_number}/locations/{location_id}/lakes/{lake_id}",
+                      "description": "Required. The resource name of the lake: projects/{project_number}/locations/{location_id}/lakes/{lake_id}.",
                       "location": "path",
                       "pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+$",
                       "required": true,
@@ -252,7 +252,7 @@
                   ],
                   "parameters": {
                     "name": {
-                      "description": "Required. The resource name of the lake: projects/{project_number}/locations/{location_id}/lakes/{lake_id}",
+                      "description": "Required. The resource name of the lake: projects/{project_number}/locations/{location_id}/lakes/{lake_id}.",
                       "location": "path",
                       "pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+$",
                       "required": true,
@@ -464,7 +464,7 @@
                           "type": "string"
                         },
                         "parent": {
-                          "description": "Required. The resource name of the parent lake: projects/{project_number}/locations/{location_id}/lakes/{lake_id}",
+                          "description": "Required. The resource name of the parent lake: projects/{project_number}/locations/{location_id}/lakes/{lake_id}.",
                           "location": "path",
                           "pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+$",
                           "required": true,
@@ -1036,7 +1036,7 @@
                           "type": "string"
                         },
                         "parent": {
-                          "description": "Required. The resource name of the parent lake: projects/{project_id}/locations/{location_id}/lakes/{lake_id}",
+                          "description": "Required. The resource name of the parent lake: projects/{project_id}/locations/{location_id}/lakes/{lake_id}.",
                           "location": "path",
                           "pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+$",
                           "required": true,
@@ -1069,7 +1069,7 @@
                       ],
                       "parameters": {
                         "name": {
-                          "description": "Required. The resource name of the environment: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/environments/{environment_id}`",
+                          "description": "Required. The resource name of the environment: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/environments/{environment_id}.",
                           "location": "path",
                           "pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+/environments/[^/]+$",
                           "required": true,
@@ -1094,7 +1094,7 @@
                       ],
                       "parameters": {
                         "name": {
-                          "description": "Required. The resource name of the environment: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/environments/{environment_id}",
+                          "description": "Required. The resource name of the environment: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/environments/{environment_id}.",
                           "location": "path",
                           "pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+/environments/[^/]+$",
                           "required": true,
@@ -1171,7 +1171,7 @@
                           "type": "string"
                         },
                         "parent": {
-                          "description": "Required. The resource name of the parent lake: projects/{project_id}/locations/{location_id}/lakes/{lake_id}",
+                          "description": "Required. The resource name of the parent lake: projects/{project_id}/locations/{location_id}/lakes/{lake_id}.",
                           "location": "path",
                           "pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+$",
                           "required": true,
@@ -1311,7 +1311,7 @@
                               "type": "string"
                             },
                             "parent": {
-                              "description": "Required. The resource name of the parent environment: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/environment/{environment_id}",
+                              "description": "Required. The resource name of the parent environment: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/environment/{environment_id}.",
                               "location": "path",
                               "pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+/environments/[^/]+$",
                               "required": true,
@@ -1342,7 +1342,7 @@
                       ],
                       "parameters": {
                         "parent": {
-                          "description": "Required. The resource name of the parent lake: projects/{project_number}/locations/{location_id}/lakes/{lake_id}",
+                          "description": "Required. The resource name of the parent lake: projects/{project_number}/locations/{location_id}/lakes/{lake_id}.",
                           "location": "path",
                           "pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+$",
                           "required": true,
@@ -1380,7 +1380,7 @@
                       ],
                       "parameters": {
                         "name": {
-                          "description": "Required. The resource name of the task: projects/{project_number}/locations/{location_id}/lakes/{lake_id} /task/{task_id}`",
+                          "description": "Required. The resource name of the task: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/task/{task_id}.",
                           "location": "path",
                           "pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+/tasks/[^/]+$",
                           "required": true,
@@ -1405,7 +1405,7 @@
                       ],
                       "parameters": {
                         "name": {
-                          "description": "Required. The resource name of the task: projects/{project_number}/locations/{location_id}/lakes/{lake_id} /tasks/{tasks_id}",
+                          "description": "Required. The resource name of the task: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/tasks/{tasks_id}.",
                           "location": "path",
                           "pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+/tasks/[^/]+$",
                           "required": true,
@@ -1482,7 +1482,7 @@
                           "type": "string"
                         },
                         "parent": {
-                          "description": "Required. The resource name of the parent lake: projects/{project_number}/locations/{location_id}/lakes/{lake_id}",
+                          "description": "Required. The resource name of the parent lake: projects/{project_number}/locations/{location_id}/lakes/{lake_id}.",
                           "location": "path",
                           "pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+$",
                           "required": true,
@@ -1606,7 +1606,7 @@
                           ],
                           "parameters": {
                             "name": {
-                              "description": "Required. The resource name of the job: projects/{project_number}/locations/{location_id}/lakes/{lake_id} /task/{task_id}/job/{job_id}`",
+                              "description": "Required. The resource name of the job: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/task/{task_id}/job/{job_id}.",
                               "location": "path",
                               "pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+/tasks/[^/]+/jobs/[^/]+$",
                               "required": true,
@@ -1634,7 +1634,7 @@
                           ],
                           "parameters": {
                             "name": {
-                              "description": "Required. The resource name of the job: projects/{project_number}/locations/{location_id}/lakes/{lake_id} /tasks/{task_id}/jobs/{job_id}",
+                              "description": "Required. The resource name of the job: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/tasks/{task_id}/jobs/{job_id}.",
                               "location": "path",
                               "pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+/tasks/[^/]+/jobs/[^/]+$",
                               "required": true,
@@ -1670,7 +1670,7 @@
                               "type": "string"
                             },
                             "parent": {
-                              "description": "Required. The resource name of the parent environment: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/tasks/{task_id}",
+                              "description": "Required. The resource name of the parent environment: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/tasks/{task_id}.",
                               "location": "path",
                               "pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+/tasks/[^/]+$",
                               "required": true,
@@ -1701,7 +1701,7 @@
                       ],
                       "parameters": {
                         "parent": {
-                          "description": "Required. The resource name of the parent lake: projects/{project_number}/locations/{location_id}/lakes/{lake_id}",
+                          "description": "Required. The resource name of the parent lake: projects/{project_number}/locations/{location_id}/lakes/{lake_id}.",
                           "location": "path",
                           "pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+$",
                           "required": true,
@@ -1739,7 +1739,7 @@
                       ],
                       "parameters": {
                         "name": {
-                          "description": "Required. The resource name of the zone: projects/{project_number}/locations/{location_id}/lakes/{lake_id} /zones/{zone_id}`",
+                          "description": "Required. The resource name of the zone: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}.",
                           "location": "path",
                           "pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+/zones/[^/]+$",
                           "required": true,
@@ -1764,7 +1764,7 @@
                       ],
                       "parameters": {
                         "name": {
-                          "description": "Required. The resource name of the zone: projects/{project_number}/locations/{location_id}/lakes/{lake_id} /zones/{zone_id}",
+                          "description": "Required. The resource name of the zone: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}.",
                           "location": "path",
                           "pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+/zones/[^/]+$",
                           "required": true,
@@ -1841,7 +1841,7 @@
                           "type": "string"
                         },
                         "parent": {
-                          "description": "Required. The resource name of the parent lake: projects/{project_number}/locations/{location_id}/lakes/{lake_id}",
+                          "description": "Required. The resource name of the parent lake: projects/{project_number}/locations/{location_id}/lakes/{lake_id}.",
                           "location": "path",
                           "pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+$",
                           "required": true,
@@ -1976,7 +1976,7 @@
                               "type": "string"
                             },
                             "parent": {
-                              "description": "Required. The resource name of the parent zone: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}",
+                              "description": "Required. The resource name of the parent zone: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}.",
                               "location": "path",
                               "pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+/zones/[^/]+$",
                               "required": true,
@@ -2010,7 +2010,7 @@
                               "type": "string"
                             },
                             "parent": {
-                              "description": "Required. The resource name of the parent zone: projects/{project_number}/locations/{location_id}/lakes/{lake_id} /zones/{zone_id}`",
+                              "description": "Required. The resource name of the parent zone: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}.",
                               "location": "path",
                               "pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+/zones/[^/]+$",
                               "required": true,
@@ -2043,7 +2043,7 @@
                           ],
                           "parameters": {
                             "name": {
-                              "description": "Required. The resource name of the asset: projects/{project_number}/locations/{location_id}/lakes/{lake_id} /zones/{zone_id}/assets/{asset_id}",
+                              "description": "Required. The resource name of the asset: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/assets/{asset_id}.",
                               "location": "path",
                               "pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+/zones/[^/]+/assets/[^/]+$",
                               "required": true,
@@ -2068,7 +2068,7 @@
                           ],
                           "parameters": {
                             "name": {
-                              "description": "Required. The resource name of the asset: projects/{project_number}/locations/{location_id}/lakes/{lake_id} /zones/{zone_id}/assets/{asset_id}",
+                              "description": "Required. The resource name of the asset: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/assets/{asset_id}.",
                               "location": "path",
                               "pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+/zones/[^/]+/assets/[^/]+$",
                               "required": true,
@@ -2145,7 +2145,7 @@
                               "type": "string"
                             },
                             "parent": {
-                              "description": "Required. The resource name of the parent zone: projects/{project_number}/locations/{location_id}/lakes/{lake_id} /zones/{zone_id}`",
+                              "description": "Required. The resource name of the parent zone: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}.",
                               "location": "path",
                               "pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+/zones/[^/]+$",
                               "required": true,
@@ -2280,7 +2280,7 @@
                                   "type": "string"
                                 },
                                 "parent": {
-                                  "description": "Required. The resource name of the parent asset: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/assets/{asset_id}",
+                                  "description": "Required. The resource name of the parent asset: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/assets/{asset_id}.",
                                   "location": "path",
                                   "pattern": "^projects/[^/]+/locations/[^/]+/lakes/[^/]+/zones/[^/]+/assets/[^/]+$",
                                   "required": true,
@@ -2764,7 +2764,7 @@
       }
     }
   },
-  "revision": "20220621",
+  "revision": "20220711",
   "rootUrl": "https://dataplex.googleapis.com/",
   "schemas": {
     "Empty": {
@@ -3921,12 +3921,12 @@
           "type": "string"
         },
         "name": {
-          "description": "Output only. The relative resource name of the job, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/ tasks/{task_id}/jobs/{job_id}.",
+          "description": "Output only. The relative resource name of the job, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/tasks/{task_id}/jobs/{job_id}.",
           "readOnly": true,
           "type": "string"
         },
         "retryCount": {
-          "description": "Output only. . The number of times the job has been retried (excluding the initial attempt).",
+          "description": "Output only. The number of times the job has been retried (excluding the initial attempt).",
           "format": "uint32",
           "readOnly": true,
           "type": "integer"
@@ -4962,6 +4962,10 @@
           "description": "Optional. The arguments to pass to the task. The args can use placeholders of the format ${placeholder} as part of key/value string. These will be interpolated before passing the args to the driver. Currently supported placeholders: - ${task_id} - ${job_time} To pass positional args, set the key as TASK_ARGS. The value should be a comma-separated string of all the positional arguments. To use a delimiter other than comma, refer to https://cloud.google.com/sdk/gcloud/reference/topic/escaping. In case of other keys being present in the args, then TASK_ARGS will be passed as the last argument.",
           "type": "object"
         },
+        "kmsKey": {
+          "description": "Optional. The Cloud KMS key to use for encryption, of the form: projects/{project_number}/locations/{location_id}/keyRings/{key-ring-name}/cryptoKeys/{key-name}.",
+          "type": "string"
+        },
         "maxJobExecutionLifetime": {
           "description": "Optional. The maximum duration after which the job execution is expired.",
           "format": "google-duration",
@@ -5036,6 +5040,10 @@
       "description": "Container Image Runtime Configuration used with Batch execution.",
       "id": "GoogleCloudDataplexV1TaskInfrastructureSpecContainerImageRuntime",
       "properties": {
+        "image": {
+          "description": "Optional. Container image to use.",
+          "type": "string"
+        },
         "javaJars": {
           "description": "Optional. A list of Java JARS to add to the classpath. Valid input includes Cloud Storage URIs to Jar binaries. For example, gs://bucket-name/my/path/to/file.jar",
           "items": {

From 56fb20ac3ca019d21b94ae4c8db83e8e065a4bf3 Mon Sep 17 00:00:00 2001
From: Yoshi Automation 
Date: Tue, 19 Jul 2022 07:08:13 +0000
Subject: [PATCH 14/23] feat(documentai): update the api

#### documentai:v1

The following keys were added:
- resources.projects.resources.locations.resources.processorTypes.methods.list (Total Keys: 16)
- schemas.GoogleCloudDocumentaiV1Barcode (Total Keys: 5)
- schemas.GoogleCloudDocumentaiV1DocumentPage.properties.detectedBarcodes (Total Keys: 2)
- schemas.GoogleCloudDocumentaiV1DocumentPageDetectedBarcode (Total Keys: 4)
- schemas.GoogleCloudDocumentaiV1DocumentSchemaMetadata.properties.prefixedNamingOnProperties.type (Total Keys: 1)
- schemas.GoogleCloudDocumentaiV1ListProcessorTypesResponse (Total Keys: 5)
- schemas.GoogleCloudDocumentaiV1beta1Barcode (Total Keys: 5)
- schemas.GoogleCloudDocumentaiV1beta1DocumentPage.properties.detectedBarcodes (Total Keys: 2)
- schemas.GoogleCloudDocumentaiV1beta1DocumentPageDetectedBarcode (Total Keys: 4)
- schemas.GoogleCloudDocumentaiV1beta2Barcode (Total Keys: 5)
- schemas.GoogleCloudDocumentaiV1beta2DocumentPage.properties.detectedBarcodes (Total Keys: 2)
- schemas.GoogleCloudDocumentaiV1beta2DocumentPageDetectedBarcode (Total Keys: 4)

#### documentai:v1beta2

The following keys were added:
- schemas.GoogleCloudDocumentaiV1beta1Barcode (Total Keys: 5)
- schemas.GoogleCloudDocumentaiV1beta1DocumentPage.properties.detectedBarcodes (Total Keys: 2)
- schemas.GoogleCloudDocumentaiV1beta1DocumentPageDetectedBarcode (Total Keys: 4)
- schemas.GoogleCloudDocumentaiV1beta2Barcode (Total Keys: 5)
- schemas.GoogleCloudDocumentaiV1beta2DocumentPage.properties.detectedBarcodes (Total Keys: 2)
- schemas.GoogleCloudDocumentaiV1beta2DocumentPageDetectedBarcode (Total Keys: 4)

#### documentai:v1beta3

The following keys were added:
- resources.projects.resources.locations.resources.processorTypes.methods.list (Total Keys: 16)
- schemas.GoogleCloudDocumentaiV1beta1Barcode (Total Keys: 5)
- schemas.GoogleCloudDocumentaiV1beta1DocumentPage.properties.detectedBarcodes (Total Keys: 2)
- schemas.GoogleCloudDocumentaiV1beta1DocumentPageDetectedBarcode (Total Keys: 4)
- schemas.GoogleCloudDocumentaiV1beta2Barcode (Total Keys: 5)
- schemas.GoogleCloudDocumentaiV1beta2DocumentPage.properties.detectedBarcodes (Total Keys: 2)
- schemas.GoogleCloudDocumentaiV1beta2DocumentPageDetectedBarcode (Total Keys: 4)
- schemas.GoogleCloudDocumentaiV1beta3Barcode (Total Keys: 5)
- schemas.GoogleCloudDocumentaiV1beta3DocumentPage.properties.detectedBarcodes (Total Keys: 2)
- schemas.GoogleCloudDocumentaiV1beta3DocumentPageDetectedBarcode (Total Keys: 4)
- schemas.GoogleCloudDocumentaiV1beta3DocumentSchemaMetadata.properties.prefixedNamingOnProperties.type (Total Keys: 1)
- schemas.GoogleCloudDocumentaiV1beta3ListProcessorTypesResponse (Total Keys: 5)
---
 .../dyn/documentai_v1.projects.locations.html |   5 +
 ..._v1.projects.locations.processorTypes.html | 141 +++++++++++++
 ...ntai_v1.projects.locations.processors.html |  76 ++++++-
 ...ocations.processors.humanReviewConfig.html |  39 +++-
 ...ocations.processors.processorVersions.html |  76 ++++++-
 ...documentai_v1beta2.projects.documents.html |  38 +++-
 ..._v1beta2.projects.locations.documents.html |  38 +++-
 ...documentai_v1beta3.projects.locations.html |   5 +
 ...ta3.projects.locations.processorTypes.html | 141 +++++++++++++
 ...v1beta3.projects.locations.processors.html | 114 ++++++++++-
 ...ocations.processors.humanReviewConfig.html |  77 ++++++-
 ...ocations.processors.processorVersions.html | 114 ++++++++++-
 .../documents/documentai.v1.json              | 189 +++++++++++++++++-
 .../documents/documentai.v1beta2.json         |  86 +++++++-
 .../documents/documentai.v1beta3.json         | 189 +++++++++++++++++-
 15 files changed, 1307 insertions(+), 21 deletions(-)
 create mode 100644 docs/dyn/documentai_v1.projects.locations.processorTypes.html
 create mode 100644 docs/dyn/documentai_v1beta3.projects.locations.processorTypes.html

diff --git a/docs/dyn/documentai_v1.projects.locations.html b/docs/dyn/documentai_v1.projects.locations.html
index 7fc136df579..26eceb2f351 100644
--- a/docs/dyn/documentai_v1.projects.locations.html
+++ b/docs/dyn/documentai_v1.projects.locations.html
@@ -79,6 +79,11 @@ 

Instance Methods

Returns the operations Resource.

+

+ processorTypes() +

+

Returns the processorTypes Resource.

+

processors()

diff --git a/docs/dyn/documentai_v1.projects.locations.processorTypes.html b/docs/dyn/documentai_v1.projects.locations.processorTypes.html new file mode 100644 index 00000000000..e96b08572d2 --- /dev/null +++ b/docs/dyn/documentai_v1.projects.locations.processorTypes.html @@ -0,0 +1,141 @@ + + + +

Cloud Document AI API . projects . locations . processorTypes

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ list(parent, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists the processor types that exist.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) +
Lists the processor types that exist.
+
+Args:
+  parent: string, Required. The location of processor type to list. The available processor types may depend on the allow-listing on projects. Format: `projects/{project}/locations/{location}` (required)
+  pageSize: integer, The maximum number of processor types to return. If unspecified, at most 100 processor types will be returned. The maximum value is 500; values above 500 will be coerced to 500.
+  pageToken: string, Used to retrieve the next page of results, empty if at the end of the list.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for list processor types.
+  "nextPageToken": "A String", # Points to the next page, otherwise empty.
+  "processorTypes": [ # The processor types.
+    { # A processor type is responsible for performing a certain document understanding task on a certain type of document.
+      "allowCreation": True or False, # Whether the processor type allows creation. If true, users can create a processor of this processor type. Otherwise, users need to request access.
+      "availableLocations": [ # The locations in which this processor is available.
+        { # The location information about where the processor is available.
+          "locationId": "A String", # The location id, currently must be one of [us, eu].
+        },
+      ],
+      "category": "A String", # The processor category, used by UI to group processor types.
+      "launchStage": "A String", # Launch stage of the processor type
+      "name": "A String", # The resource name of the processor type. Format: projects/{project}/processorTypes/{processor_type}
+      "type": "A String", # The type of the processor, e.g., "invoice_parsing".
+    },
+  ],
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/documentai_v1.projects.locations.processors.html b/docs/dyn/documentai_v1.projects.locations.processors.html index f34bca4dc98..b25e72d7480 100644 --- a/docs/dyn/documentai_v1.projects.locations.processors.html +++ b/docs/dyn/documentai_v1.projects.locations.processors.html @@ -434,7 +434,7 @@

Method Details

"mentionText": "A String", # Optional. Text value in the document e.g. `1600 Amphitheatre Pkwy`. If the entity is not present in the document, this field will be empty. "nonPresent": True or False, # Optional. This attribute indicates that the processing didn't actually identify this entity, but a confidence score was assigned that represent the potential that this could be a false negative. A non-present entity should have an empty mention_text and text_anchor. "normalizedValue": { # Parsed and normalized entity value. # Optional. Normalized entity value. Absent if the extracted value could not be converted or the type (e.g. address) is not supported for certain parsers. This field is also only populated for certain supported document types. - "addressValue": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Postal address. See also: https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto + "addressValue": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Postal address. See also: https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -600,6 +600,42 @@

Method Details

}, }, ], + "detectedBarcodes": [ # A list of detected barcodes. + { # A detected barcode. + "barcode": { # Encodes the detailed information of a barcode. # Detailed barcode information of the DetectedBarcode. + "format": "A String", # Format of a barcode. The supported formats are: CODE_128: Code 128 type. CODE_39: Code 39 type. CODE_93: Code 93 type. CODABAR: Codabar type. DATA_MATRIX: 2D Data Matrix type. ITF: ITF type. EAN_13: EAN-13 type. EAN_8: EAN-8 type. QR_CODE: 2D QR code type. UPC_A: UPC-A type. UPC_E: UPC-E type. PDF417: PDF417 type. AZTEC: 2D Aztec code type. DATABAR: GS1 DataBar code type. + "rawValue": "A String", # Raw value encoded in the barcode. For example, 'MEBKM:TITLE:Google;URL:https://www.google.com;;'. + "valueFormat": "A String", # Value format describes the format of the value that a barcode encodes. The supported formats are: CONTACT_INFO: Contact information. EMAIL: Email address. ISBN: ISBN identifier. PHONE: Phone number. PRODUCT: Product. SMS: SMS message. TEXT: Text string. URL: URL address. WIFI: Wifi information. GEO: Geo-localization. CALENDAR_EVENT: Calendar event. DRIVER_LICENSE: Driver's license. + }, + "layout": { # Visual element describing a layout unit on a page. # Layout for DetectedBarcode. + "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout. + "normalizedVertices": [ # The bounding polygon normalized vertices. + { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1. + "x": 3.14, # X coordinate. + "y": 3.14, # Y coordinate (starts from the top of the image). + }, + ], + "vertices": [ # The bounding polygon vertices. + { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image. + "x": 42, # X coordinate. + "y": 42, # Y coordinate (starts from the top of the image). + }, + ], + }, + "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range [0, 1]. + "orientation": "A String", # Detected orientation for the Layout. + "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text. + "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields. + "textSegments": [ # The text segments from the Document.text. + { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset + "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text. + "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text. + }, + ], + }, + }, + }, + ], "detectedLanguages": [ # A list of detected languages together with confidence. { # Detected language for a structural component. "confidence": 3.14, # Confidence of detected language. Range [0, 1]. @@ -1212,7 +1248,7 @@

Method Details

"mentionText": "A String", # Optional. Text value in the document e.g. `1600 Amphitheatre Pkwy`. If the entity is not present in the document, this field will be empty. "nonPresent": True or False, # Optional. This attribute indicates that the processing didn't actually identify this entity, but a confidence score was assigned that represent the potential that this could be a false negative. A non-present entity should have an empty mention_text and text_anchor. "normalizedValue": { # Parsed and normalized entity value. # Optional. Normalized entity value. Absent if the extracted value could not be converted or the type (e.g. address) is not supported for certain parsers. This field is also only populated for certain supported document types. - "addressValue": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Postal address. See also: https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto + "addressValue": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Postal address. See also: https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -1378,6 +1414,42 @@

Method Details

}, }, ], + "detectedBarcodes": [ # A list of detected barcodes. + { # A detected barcode. + "barcode": { # Encodes the detailed information of a barcode. # Detailed barcode information of the DetectedBarcode. + "format": "A String", # Format of a barcode. The supported formats are: CODE_128: Code 128 type. CODE_39: Code 39 type. CODE_93: Code 93 type. CODABAR: Codabar type. DATA_MATRIX: 2D Data Matrix type. ITF: ITF type. EAN_13: EAN-13 type. EAN_8: EAN-8 type. QR_CODE: 2D QR code type. UPC_A: UPC-A type. UPC_E: UPC-E type. PDF417: PDF417 type. AZTEC: 2D Aztec code type. DATABAR: GS1 DataBar code type. + "rawValue": "A String", # Raw value encoded in the barcode. For example, 'MEBKM:TITLE:Google;URL:https://www.google.com;;'. + "valueFormat": "A String", # Value format describes the format of the value that a barcode encodes. The supported formats are: CONTACT_INFO: Contact information. EMAIL: Email address. ISBN: ISBN identifier. PHONE: Phone number. PRODUCT: Product. SMS: SMS message. TEXT: Text string. URL: URL address. WIFI: Wifi information. GEO: Geo-localization. CALENDAR_EVENT: Calendar event. DRIVER_LICENSE: Driver's license. + }, + "layout": { # Visual element describing a layout unit on a page. # Layout for DetectedBarcode. + "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout. + "normalizedVertices": [ # The bounding polygon normalized vertices. + { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1. + "x": 3.14, # X coordinate. + "y": 3.14, # Y coordinate (starts from the top of the image). + }, + ], + "vertices": [ # The bounding polygon vertices. + { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image. + "x": 42, # X coordinate. + "y": 42, # Y coordinate (starts from the top of the image). + }, + ], + }, + "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range [0, 1]. + "orientation": "A String", # Detected orientation for the Layout. + "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text. + "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields. + "textSegments": [ # The text segments from the Document.text. + { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset + "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text. + "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text. + }, + ], + }, + }, + }, + ], "detectedLanguages": [ # A list of detected languages together with confidence. { # Detected language for a structural component. "confidence": 3.14, # Confidence of detected language. Range [0, 1]. diff --git a/docs/dyn/documentai_v1.projects.locations.processors.humanReviewConfig.html b/docs/dyn/documentai_v1.projects.locations.processors.humanReviewConfig.html index 466e1209157..4d8610068a4 100644 --- a/docs/dyn/documentai_v1.projects.locations.processors.humanReviewConfig.html +++ b/docs/dyn/documentai_v1.projects.locations.processors.humanReviewConfig.html @@ -123,6 +123,7 @@

Method Details

"metadata": { # Metadata for global schema behavior. # Metadata of the schema. "documentAllowMultipleLabels": True or False, # If true, on a given page, there can be multiple `document` annotations covering it. "documentSplitter": True or False, # If true, a `document` entity type can be applied to subdocument ( splitting). Otherwise, it can only be applied to the entire document (classification). + "prefixedNamingOnProperties": True or False, # If set, all the nested entities must be prefixed with the parents. }, }, "enableSchemaValidation": True or False, # Whether the validation should be performed on the ad-hoc review request. @@ -136,7 +137,7 @@

Method Details

"mentionText": "A String", # Optional. Text value in the document e.g. `1600 Amphitheatre Pkwy`. If the entity is not present in the document, this field will be empty. "nonPresent": True or False, # Optional. This attribute indicates that the processing didn't actually identify this entity, but a confidence score was assigned that represent the potential that this could be a false negative. A non-present entity should have an empty mention_text and text_anchor. "normalizedValue": { # Parsed and normalized entity value. # Optional. Normalized entity value. Absent if the extracted value could not be converted or the type (e.g. address) is not supported for certain parsers. This field is also only populated for certain supported document types. - "addressValue": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Postal address. See also: https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto + "addressValue": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Postal address. See also: https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -302,6 +303,42 @@

Method Details

}, }, ], + "detectedBarcodes": [ # A list of detected barcodes. + { # A detected barcode. + "barcode": { # Encodes the detailed information of a barcode. # Detailed barcode information of the DetectedBarcode. + "format": "A String", # Format of a barcode. The supported formats are: CODE_128: Code 128 type. CODE_39: Code 39 type. CODE_93: Code 93 type. CODABAR: Codabar type. DATA_MATRIX: 2D Data Matrix type. ITF: ITF type. EAN_13: EAN-13 type. EAN_8: EAN-8 type. QR_CODE: 2D QR code type. UPC_A: UPC-A type. UPC_E: UPC-E type. PDF417: PDF417 type. AZTEC: 2D Aztec code type. DATABAR: GS1 DataBar code type. + "rawValue": "A String", # Raw value encoded in the barcode. For example, 'MEBKM:TITLE:Google;URL:https://www.google.com;;'. + "valueFormat": "A String", # Value format describes the format of the value that a barcode encodes. The supported formats are: CONTACT_INFO: Contact information. EMAIL: Email address. ISBN: ISBN identifier. PHONE: Phone number. PRODUCT: Product. SMS: SMS message. TEXT: Text string. URL: URL address. WIFI: Wifi information. GEO: Geo-localization. CALENDAR_EVENT: Calendar event. DRIVER_LICENSE: Driver's license. + }, + "layout": { # Visual element describing a layout unit on a page. # Layout for DetectedBarcode. + "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout. + "normalizedVertices": [ # The bounding polygon normalized vertices. + { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1. + "x": 3.14, # X coordinate. + "y": 3.14, # Y coordinate (starts from the top of the image). + }, + ], + "vertices": [ # The bounding polygon vertices. + { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image. + "x": 42, # X coordinate. + "y": 42, # Y coordinate (starts from the top of the image). + }, + ], + }, + "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range [0, 1]. + "orientation": "A String", # Detected orientation for the Layout. + "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text. + "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields. + "textSegments": [ # The text segments from the Document.text. + { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset + "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text. + "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text. + }, + ], + }, + }, + }, + ], "detectedLanguages": [ # A list of detected languages together with confidence. { # Detected language for a structural component. "confidence": 3.14, # Confidence of detected language. Range [0, 1]. diff --git a/docs/dyn/documentai_v1.projects.locations.processors.processorVersions.html b/docs/dyn/documentai_v1.projects.locations.processors.processorVersions.html index 07352a1b1f4..cd43192e67d 100644 --- a/docs/dyn/documentai_v1.projects.locations.processors.processorVersions.html +++ b/docs/dyn/documentai_v1.projects.locations.processors.processorVersions.html @@ -343,7 +343,7 @@

Method Details

"mentionText": "A String", # Optional. Text value in the document e.g. `1600 Amphitheatre Pkwy`. If the entity is not present in the document, this field will be empty. "nonPresent": True or False, # Optional. This attribute indicates that the processing didn't actually identify this entity, but a confidence score was assigned that represent the potential that this could be a false negative. A non-present entity should have an empty mention_text and text_anchor. "normalizedValue": { # Parsed and normalized entity value. # Optional. Normalized entity value. Absent if the extracted value could not be converted or the type (e.g. address) is not supported for certain parsers. This field is also only populated for certain supported document types. - "addressValue": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Postal address. See also: https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto + "addressValue": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Postal address. See also: https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -509,6 +509,42 @@

Method Details

}, }, ], + "detectedBarcodes": [ # A list of detected barcodes. + { # A detected barcode. + "barcode": { # Encodes the detailed information of a barcode. # Detailed barcode information of the DetectedBarcode. + "format": "A String", # Format of a barcode. The supported formats are: CODE_128: Code 128 type. CODE_39: Code 39 type. CODE_93: Code 93 type. CODABAR: Codabar type. DATA_MATRIX: 2D Data Matrix type. ITF: ITF type. EAN_13: EAN-13 type. EAN_8: EAN-8 type. QR_CODE: 2D QR code type. UPC_A: UPC-A type. UPC_E: UPC-E type. PDF417: PDF417 type. AZTEC: 2D Aztec code type. DATABAR: GS1 DataBar code type. + "rawValue": "A String", # Raw value encoded in the barcode. For example, 'MEBKM:TITLE:Google;URL:https://www.google.com;;'. + "valueFormat": "A String", # Value format describes the format of the value that a barcode encodes. The supported formats are: CONTACT_INFO: Contact information. EMAIL: Email address. ISBN: ISBN identifier. PHONE: Phone number. PRODUCT: Product. SMS: SMS message. TEXT: Text string. URL: URL address. WIFI: Wifi information. GEO: Geo-localization. CALENDAR_EVENT: Calendar event. DRIVER_LICENSE: Driver's license. + }, + "layout": { # Visual element describing a layout unit on a page. # Layout for DetectedBarcode. + "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout. + "normalizedVertices": [ # The bounding polygon normalized vertices. + { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1. + "x": 3.14, # X coordinate. + "y": 3.14, # Y coordinate (starts from the top of the image). + }, + ], + "vertices": [ # The bounding polygon vertices. + { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image. + "x": 42, # X coordinate. + "y": 42, # Y coordinate (starts from the top of the image). + }, + ], + }, + "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range [0, 1]. + "orientation": "A String", # Detected orientation for the Layout. + "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text. + "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields. + "textSegments": [ # The text segments from the Document.text. + { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset + "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text. + "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text. + }, + ], + }, + }, + }, + ], "detectedLanguages": [ # A list of detected languages together with confidence. { # Detected language for a structural component. "confidence": 3.14, # Confidence of detected language. Range [0, 1]. @@ -1121,7 +1157,7 @@

Method Details

"mentionText": "A String", # Optional. Text value in the document e.g. `1600 Amphitheatre Pkwy`. If the entity is not present in the document, this field will be empty. "nonPresent": True or False, # Optional. This attribute indicates that the processing didn't actually identify this entity, but a confidence score was assigned that represent the potential that this could be a false negative. A non-present entity should have an empty mention_text and text_anchor. "normalizedValue": { # Parsed and normalized entity value. # Optional. Normalized entity value. Absent if the extracted value could not be converted or the type (e.g. address) is not supported for certain parsers. This field is also only populated for certain supported document types. - "addressValue": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Postal address. See also: https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto + "addressValue": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Postal address. See also: https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -1287,6 +1323,42 @@

Method Details

}, }, ], + "detectedBarcodes": [ # A list of detected barcodes. + { # A detected barcode. + "barcode": { # Encodes the detailed information of a barcode. # Detailed barcode information of the DetectedBarcode. + "format": "A String", # Format of a barcode. The supported formats are: CODE_128: Code 128 type. CODE_39: Code 39 type. CODE_93: Code 93 type. CODABAR: Codabar type. DATA_MATRIX: 2D Data Matrix type. ITF: ITF type. EAN_13: EAN-13 type. EAN_8: EAN-8 type. QR_CODE: 2D QR code type. UPC_A: UPC-A type. UPC_E: UPC-E type. PDF417: PDF417 type. AZTEC: 2D Aztec code type. DATABAR: GS1 DataBar code type. + "rawValue": "A String", # Raw value encoded in the barcode. For example, 'MEBKM:TITLE:Google;URL:https://www.google.com;;'. + "valueFormat": "A String", # Value format describes the format of the value that a barcode encodes. The supported formats are: CONTACT_INFO: Contact information. EMAIL: Email address. ISBN: ISBN identifier. PHONE: Phone number. PRODUCT: Product. SMS: SMS message. TEXT: Text string. URL: URL address. WIFI: Wifi information. GEO: Geo-localization. CALENDAR_EVENT: Calendar event. DRIVER_LICENSE: Driver's license. + }, + "layout": { # Visual element describing a layout unit on a page. # Layout for DetectedBarcode. + "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout. + "normalizedVertices": [ # The bounding polygon normalized vertices. + { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1. + "x": 3.14, # X coordinate. + "y": 3.14, # Y coordinate (starts from the top of the image). + }, + ], + "vertices": [ # The bounding polygon vertices. + { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image. + "x": 42, # X coordinate. + "y": 42, # Y coordinate (starts from the top of the image). + }, + ], + }, + "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range [0, 1]. + "orientation": "A String", # Detected orientation for the Layout. + "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text. + "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields. + "textSegments": [ # The text segments from the Document.text. + { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset + "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text. + "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text. + }, + ], + }, + }, + }, + ], "detectedLanguages": [ # A list of detected languages together with confidence. { # Detected language for a structural component. "confidence": 3.14, # Confidence of detected language. Range [0, 1]. diff --git a/docs/dyn/documentai_v1beta2.projects.documents.html b/docs/dyn/documentai_v1beta2.projects.documents.html index f0a7f594b8a..56c62115d8f 100644 --- a/docs/dyn/documentai_v1beta2.projects.documents.html +++ b/docs/dyn/documentai_v1beta2.projects.documents.html @@ -294,7 +294,7 @@

Method Details

"mentionText": "A String", # Optional. Text value in the document e.g. `1600 Amphitheatre Pkwy`. If the entity is not present in the document, this field will be empty. "nonPresent": True or False, # Optional. This attribute indicates that the processing didn't actually identify this entity, but a confidence score was assigned that represent the potential that this could be a false negative. A non-present entity should have an empty mention_text and text_anchor. "normalizedValue": { # Parsed and normalized entity value. # Optional. Normalized entity value. Absent if the extracted value could not be converted or the type (e.g. address) is not supported for certain parsers. This field is also only populated for certain supported document types. - "addressValue": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Postal address. See also: https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto + "addressValue": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Postal address. See also: https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -467,6 +467,42 @@

Method Details

}, }, ], + "detectedBarcodes": [ # A list of detected barcodes. + { # A detected barcode. + "barcode": { # Encodes the detailed information of a barcode. # Detailed barcode information of the DetectedBarcode. + "format": "A String", # Format of a barcode. The supported formats are: CODE_128: Code 128 type. CODE_39: Code 39 type. CODE_93: Code 93 type. CODABAR: Codabar type. DATA_MATRIX: 2D Data Matrix type. ITF: ITF type. EAN_13: EAN-13 type. EAN_8: EAN-8 type. QR_CODE: 2D QR code type. UPC_A: UPC-A type. UPC_E: UPC-E type. PDF417: PDF417 type. AZTEC: 2D Aztec code type. DATABAR: GS1 DataBar code type. + "rawValue": "A String", # Raw value encoded in the barcode. For example, 'MEBKM:TITLE:Google;URL:https://www.google.com;;'. + "valueFormat": "A String", # Value format describes the format of the value that a barcode encodes. The supported formats are: CONTACT_INFO: Contact information. EMAIL: Email address. ISBN: ISBN identifier. PHONE: Phone number. PRODUCT: Product. SMS: SMS message. TEXT: Text string. URL: URL address. WIFI: Wifi information. GEO: Geo-localization. CALENDAR_EVENT: Calendar event. DRIVER_LICENSE: Driver's license. + }, + "layout": { # Visual element describing a layout unit on a page. # Layout for DetectedBarcode. + "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout. + "normalizedVertices": [ # The bounding polygon normalized vertices. + { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1. + "x": 3.14, # X coordinate. + "y": 3.14, # Y coordinate (starts from the top of the image). + }, + ], + "vertices": [ # The bounding polygon vertices. + { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image. + "x": 42, # X coordinate. + "y": 42, # Y coordinate (starts from the top of the image). + }, + ], + }, + "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range [0, 1]. + "orientation": "A String", # Detected orientation for the Layout. + "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text. + "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields. + "textSegments": [ # The text segments from the Document.text. + { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset + "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text. + "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text. + }, + ], + }, + }, + }, + ], "detectedLanguages": [ # A list of detected languages together with confidence. { # Detected language for a structural component. "confidence": 3.14, # Confidence of detected language. Range [0, 1]. diff --git a/docs/dyn/documentai_v1beta2.projects.locations.documents.html b/docs/dyn/documentai_v1beta2.projects.locations.documents.html index 429c99b0290..6b3fba55d4c 100644 --- a/docs/dyn/documentai_v1beta2.projects.locations.documents.html +++ b/docs/dyn/documentai_v1beta2.projects.locations.documents.html @@ -294,7 +294,7 @@

Method Details

"mentionText": "A String", # Optional. Text value in the document e.g. `1600 Amphitheatre Pkwy`. If the entity is not present in the document, this field will be empty. "nonPresent": True or False, # Optional. This attribute indicates that the processing didn't actually identify this entity, but a confidence score was assigned that represent the potential that this could be a false negative. A non-present entity should have an empty mention_text and text_anchor. "normalizedValue": { # Parsed and normalized entity value. # Optional. Normalized entity value. Absent if the extracted value could not be converted or the type (e.g. address) is not supported for certain parsers. This field is also only populated for certain supported document types. - "addressValue": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Postal address. See also: https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto + "addressValue": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Postal address. See also: https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -467,6 +467,42 @@

Method Details

}, }, ], + "detectedBarcodes": [ # A list of detected barcodes. + { # A detected barcode. + "barcode": { # Encodes the detailed information of a barcode. # Detailed barcode information of the DetectedBarcode. + "format": "A String", # Format of a barcode. The supported formats are: CODE_128: Code 128 type. CODE_39: Code 39 type. CODE_93: Code 93 type. CODABAR: Codabar type. DATA_MATRIX: 2D Data Matrix type. ITF: ITF type. EAN_13: EAN-13 type. EAN_8: EAN-8 type. QR_CODE: 2D QR code type. UPC_A: UPC-A type. UPC_E: UPC-E type. PDF417: PDF417 type. AZTEC: 2D Aztec code type. DATABAR: GS1 DataBar code type. + "rawValue": "A String", # Raw value encoded in the barcode. For example, 'MEBKM:TITLE:Google;URL:https://www.google.com;;'. + "valueFormat": "A String", # Value format describes the format of the value that a barcode encodes. The supported formats are: CONTACT_INFO: Contact information. EMAIL: Email address. ISBN: ISBN identifier. PHONE: Phone number. PRODUCT: Product. SMS: SMS message. TEXT: Text string. URL: URL address. WIFI: Wifi information. GEO: Geo-localization. CALENDAR_EVENT: Calendar event. DRIVER_LICENSE: Driver's license. + }, + "layout": { # Visual element describing a layout unit on a page. # Layout for DetectedBarcode. + "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout. + "normalizedVertices": [ # The bounding polygon normalized vertices. + { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1. + "x": 3.14, # X coordinate. + "y": 3.14, # Y coordinate (starts from the top of the image). + }, + ], + "vertices": [ # The bounding polygon vertices. + { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image. + "x": 42, # X coordinate. + "y": 42, # Y coordinate (starts from the top of the image). + }, + ], + }, + "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range [0, 1]. + "orientation": "A String", # Detected orientation for the Layout. + "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text. + "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields. + "textSegments": [ # The text segments from the Document.text. + { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset + "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text. + "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text. + }, + ], + }, + }, + }, + ], "detectedLanguages": [ # A list of detected languages together with confidence. { # Detected language for a structural component. "confidence": 3.14, # Confidence of detected language. Range [0, 1]. diff --git a/docs/dyn/documentai_v1beta3.projects.locations.html b/docs/dyn/documentai_v1beta3.projects.locations.html index bd1adb06491..25e1f023af9 100644 --- a/docs/dyn/documentai_v1beta3.projects.locations.html +++ b/docs/dyn/documentai_v1beta3.projects.locations.html @@ -79,6 +79,11 @@

Instance Methods

Returns the operations Resource.

+

+ processorTypes() +

+

Returns the processorTypes Resource.

+

processors()

diff --git a/docs/dyn/documentai_v1beta3.projects.locations.processorTypes.html b/docs/dyn/documentai_v1beta3.projects.locations.processorTypes.html new file mode 100644 index 00000000000..f907ac214ae --- /dev/null +++ b/docs/dyn/documentai_v1beta3.projects.locations.processorTypes.html @@ -0,0 +1,141 @@ + + + +

Cloud Document AI API . projects . locations . processorTypes

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ list(parent, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists the processor types that exist.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) +
Lists the processor types that exist.
+
+Args:
+  parent: string, Required. The location of processor type to list. The available processor types may depend on the allow-listing on projects. Format: `projects/{project}/locations/{location}` (required)
+  pageSize: integer, The maximum number of processor types to return. If unspecified, at most 100 processor types will be returned. The maximum value is 500; values above 500 will be coerced to 500.
+  pageToken: string, Used to retrieve the next page of results, empty if at the end of the list.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for list processor types.
+  "nextPageToken": "A String", # Points to the next page, otherwise empty.
+  "processorTypes": [ # The processor types.
+    { # A processor type is responsible for performing a certain document understanding task on a certain type of document.
+      "allowCreation": True or False, # Whether the processor type allows creation. If true, users can create a processor of this processor type. Otherwise, users need to request access.
+      "availableLocations": [ # The locations in which this processor is available.
+        { # The location information about where the processor is available.
+          "locationId": "A String", # The location id, currently must be one of [us, eu].
+        },
+      ],
+      "category": "A String", # The processor category, used by UI to group processor types.
+      "launchStage": "A String", # Launch stage of the processor type
+      "name": "A String", # The resource name of the processor type. Format: projects/{project}/processorTypes/{processor_type}
+      "type": "A String", # The type of the processor, e.g., "invoice_parsing".
+    },
+  ],
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/documentai_v1beta3.projects.locations.processors.html b/docs/dyn/documentai_v1beta3.projects.locations.processors.html index 1e31714a522..256b2339561 100644 --- a/docs/dyn/documentai_v1beta3.projects.locations.processors.html +++ b/docs/dyn/documentai_v1beta3.projects.locations.processors.html @@ -442,7 +442,7 @@

Method Details

"mentionText": "A String", # Optional. Text value in the document e.g. `1600 Amphitheatre Pkwy`. If the entity is not present in the document, this field will be empty. "nonPresent": True or False, # Optional. This attribute indicates that the processing didn't actually identify this entity, but a confidence score was assigned that represent the potential that this could be a false negative. A non-present entity should have an empty mention_text and text_anchor. "normalizedValue": { # Parsed and normalized entity value. # Optional. Normalized entity value. Absent if the extracted value could not be converted or the type (e.g. address) is not supported for certain parsers. This field is also only populated for certain supported document types. - "addressValue": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Postal address. See also: https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto + "addressValue": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Postal address. See also: https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -608,6 +608,42 @@

Method Details

}, }, ], + "detectedBarcodes": [ # A list of detected barcodes. + { # A detected barcode. + "barcode": { # Encodes the detailed information of a barcode. # Detailed barcode information of the DetectedBarcode. + "format": "A String", # Format of a barcode. The supported formats are: CODE_128: Code 128 type. CODE_39: Code 39 type. CODE_93: Code 93 type. CODABAR: Codabar type. DATA_MATRIX: 2D Data Matrix type. ITF: ITF type. EAN_13: EAN-13 type. EAN_8: EAN-8 type. QR_CODE: 2D QR code type. UPC_A: UPC-A type. UPC_E: UPC-E type. PDF417: PDF417 type. AZTEC: 2D Aztec code type. DATABAR: GS1 DataBar code type. + "rawValue": "A String", # Raw value encoded in the barcode. For example, 'MEBKM:TITLE:Google;URL:https://www.google.com;;'. + "valueFormat": "A String", # Value format describes the format of the value that a barcode encodes. The supported formats are: CONTACT_INFO: Contact information. EMAIL: Email address. ISBN: ISBN identifier. PHONE: Phone number. PRODUCT: Product. SMS: SMS message. TEXT: Text string. URL: URL address. WIFI: Wifi information. GEO: Geo-localization. CALENDAR_EVENT: Calendar event. DRIVER_LICENSE: Driver's license. + }, + "layout": { # Visual element describing a layout unit on a page. # Layout for DetectedBarcode. + "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout. + "normalizedVertices": [ # The bounding polygon normalized vertices. + { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1. + "x": 3.14, # X coordinate. + "y": 3.14, # Y coordinate (starts from the top of the image). + }, + ], + "vertices": [ # The bounding polygon vertices. + { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image. + "x": 42, # X coordinate. + "y": 42, # Y coordinate (starts from the top of the image). + }, + ], + }, + "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range [0, 1]. + "orientation": "A String", # Detected orientation for the Layout. + "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text. + "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields. + "textSegments": [ # The text segments from the Document.text. + { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset + "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text. + "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text. + }, + ], + }, + }, + }, + ], "detectedLanguages": [ # A list of detected languages together with confidence. { # Detected language for a structural component. "confidence": 3.14, # Confidence of detected language. Range [0, 1]. @@ -1205,7 +1241,7 @@

Method Details

"mentionText": "A String", # Optional. Text value in the document e.g. `1600 Amphitheatre Pkwy`. If the entity is not present in the document, this field will be empty. "nonPresent": True or False, # Optional. This attribute indicates that the processing didn't actually identify this entity, but a confidence score was assigned that represent the potential that this could be a false negative. A non-present entity should have an empty mention_text and text_anchor. "normalizedValue": { # Parsed and normalized entity value. # Optional. Normalized entity value. Absent if the extracted value could not be converted or the type (e.g. address) is not supported for certain parsers. This field is also only populated for certain supported document types. - "addressValue": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Postal address. See also: https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto + "addressValue": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Postal address. See also: https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -1371,6 +1407,42 @@

Method Details

}, }, ], + "detectedBarcodes": [ # A list of detected barcodes. + { # A detected barcode. + "barcode": { # Encodes the detailed information of a barcode. # Detailed barcode information of the DetectedBarcode. + "format": "A String", # Format of a barcode. The supported formats are: CODE_128: Code 128 type. CODE_39: Code 39 type. CODE_93: Code 93 type. CODABAR: Codabar type. DATA_MATRIX: 2D Data Matrix type. ITF: ITF type. EAN_13: EAN-13 type. EAN_8: EAN-8 type. QR_CODE: 2D QR code type. UPC_A: UPC-A type. UPC_E: UPC-E type. PDF417: PDF417 type. AZTEC: 2D Aztec code type. DATABAR: GS1 DataBar code type. + "rawValue": "A String", # Raw value encoded in the barcode. For example, 'MEBKM:TITLE:Google;URL:https://www.google.com;;'. + "valueFormat": "A String", # Value format describes the format of the value that a barcode encodes. The supported formats are: CONTACT_INFO: Contact information. EMAIL: Email address. ISBN: ISBN identifier. PHONE: Phone number. PRODUCT: Product. SMS: SMS message. TEXT: Text string. URL: URL address. WIFI: Wifi information. GEO: Geo-localization. CALENDAR_EVENT: Calendar event. DRIVER_LICENSE: Driver's license. + }, + "layout": { # Visual element describing a layout unit on a page. # Layout for DetectedBarcode. + "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout. + "normalizedVertices": [ # The bounding polygon normalized vertices. + { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1. + "x": 3.14, # X coordinate. + "y": 3.14, # Y coordinate (starts from the top of the image). + }, + ], + "vertices": [ # The bounding polygon vertices. + { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image. + "x": 42, # X coordinate. + "y": 42, # Y coordinate (starts from the top of the image). + }, + ], + }, + "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range [0, 1]. + "orientation": "A String", # Detected orientation for the Layout. + "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text. + "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields. + "textSegments": [ # The text segments from the Document.text. + { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset + "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text. + "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text. + }, + ], + }, + }, + }, + ], "detectedLanguages": [ # A list of detected languages together with confidence. { # Detected language for a structural component. "confidence": 3.14, # Confidence of detected language. Range [0, 1]. @@ -1983,7 +2055,7 @@

Method Details

"mentionText": "A String", # Optional. Text value in the document e.g. `1600 Amphitheatre Pkwy`. If the entity is not present in the document, this field will be empty. "nonPresent": True or False, # Optional. This attribute indicates that the processing didn't actually identify this entity, but a confidence score was assigned that represent the potential that this could be a false negative. A non-present entity should have an empty mention_text and text_anchor. "normalizedValue": { # Parsed and normalized entity value. # Optional. Normalized entity value. Absent if the extracted value could not be converted or the type (e.g. address) is not supported for certain parsers. This field is also only populated for certain supported document types. - "addressValue": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Postal address. See also: https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto + "addressValue": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Postal address. See also: https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -2149,6 +2221,42 @@

Method Details

}, }, ], + "detectedBarcodes": [ # A list of detected barcodes. + { # A detected barcode. + "barcode": { # Encodes the detailed information of a barcode. # Detailed barcode information of the DetectedBarcode. + "format": "A String", # Format of a barcode. The supported formats are: CODE_128: Code 128 type. CODE_39: Code 39 type. CODE_93: Code 93 type. CODABAR: Codabar type. DATA_MATRIX: 2D Data Matrix type. ITF: ITF type. EAN_13: EAN-13 type. EAN_8: EAN-8 type. QR_CODE: 2D QR code type. UPC_A: UPC-A type. UPC_E: UPC-E type. PDF417: PDF417 type. AZTEC: 2D Aztec code type. DATABAR: GS1 DataBar code type. + "rawValue": "A String", # Raw value encoded in the barcode. For example, 'MEBKM:TITLE:Google;URL:https://www.google.com;;'. + "valueFormat": "A String", # Value format describes the format of the value that a barcode encodes. The supported formats are: CONTACT_INFO: Contact information. EMAIL: Email address. ISBN: ISBN identifier. PHONE: Phone number. PRODUCT: Product. SMS: SMS message. TEXT: Text string. URL: URL address. WIFI: Wifi information. GEO: Geo-localization. CALENDAR_EVENT: Calendar event. DRIVER_LICENSE: Driver's license. + }, + "layout": { # Visual element describing a layout unit on a page. # Layout for DetectedBarcode. + "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout. + "normalizedVertices": [ # The bounding polygon normalized vertices. + { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1. + "x": 3.14, # X coordinate. + "y": 3.14, # Y coordinate (starts from the top of the image). + }, + ], + "vertices": [ # The bounding polygon vertices. + { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image. + "x": 42, # X coordinate. + "y": 42, # Y coordinate (starts from the top of the image). + }, + ], + }, + "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range [0, 1]. + "orientation": "A String", # Detected orientation for the Layout. + "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text. + "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields. + "textSegments": [ # The text segments from the Document.text. + { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset + "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text. + "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text. + }, + ], + }, + }, + }, + ], "detectedLanguages": [ # A list of detected languages together with confidence. { # Detected language for a structural component. "confidence": 3.14, # Confidence of detected language. Range [0, 1]. diff --git a/docs/dyn/documentai_v1beta3.projects.locations.processors.humanReviewConfig.html b/docs/dyn/documentai_v1beta3.projects.locations.processors.humanReviewConfig.html index d29330cd894..b8d175247c1 100644 --- a/docs/dyn/documentai_v1beta3.projects.locations.processors.humanReviewConfig.html +++ b/docs/dyn/documentai_v1beta3.projects.locations.processors.humanReviewConfig.html @@ -106,7 +106,7 @@

Method Details

"mentionText": "A String", # Optional. Text value in the document e.g. `1600 Amphitheatre Pkwy`. If the entity is not present in the document, this field will be empty. "nonPresent": True or False, # Optional. This attribute indicates that the processing didn't actually identify this entity, but a confidence score was assigned that represent the potential that this could be a false negative. A non-present entity should have an empty mention_text and text_anchor. "normalizedValue": { # Parsed and normalized entity value. # Optional. Normalized entity value. Absent if the extracted value could not be converted or the type (e.g. address) is not supported for certain parsers. This field is also only populated for certain supported document types. - "addressValue": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Postal address. See also: https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto + "addressValue": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Postal address. See also: https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -272,6 +272,42 @@

Method Details

}, }, ], + "detectedBarcodes": [ # A list of detected barcodes. + { # A detected barcode. + "barcode": { # Encodes the detailed information of a barcode. # Detailed barcode information of the DetectedBarcode. + "format": "A String", # Format of a barcode. The supported formats are: CODE_128: Code 128 type. CODE_39: Code 39 type. CODE_93: Code 93 type. CODABAR: Codabar type. DATA_MATRIX: 2D Data Matrix type. ITF: ITF type. EAN_13: EAN-13 type. EAN_8: EAN-8 type. QR_CODE: 2D QR code type. UPC_A: UPC-A type. UPC_E: UPC-E type. PDF417: PDF417 type. AZTEC: 2D Aztec code type. DATABAR: GS1 DataBar code type. + "rawValue": "A String", # Raw value encoded in the barcode. For example, 'MEBKM:TITLE:Google;URL:https://www.google.com;;'. + "valueFormat": "A String", # Value format describes the format of the value that a barcode encodes. The supported formats are: CONTACT_INFO: Contact information. EMAIL: Email address. ISBN: ISBN identifier. PHONE: Phone number. PRODUCT: Product. SMS: SMS message. TEXT: Text string. URL: URL address. WIFI: Wifi information. GEO: Geo-localization. CALENDAR_EVENT: Calendar event. DRIVER_LICENSE: Driver's license. + }, + "layout": { # Visual element describing a layout unit on a page. # Layout for DetectedBarcode. + "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout. + "normalizedVertices": [ # The bounding polygon normalized vertices. + { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1. + "x": 3.14, # X coordinate. + "y": 3.14, # Y coordinate (starts from the top of the image). + }, + ], + "vertices": [ # The bounding polygon vertices. + { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image. + "x": 42, # X coordinate. + "y": 42, # Y coordinate (starts from the top of the image). + }, + ], + }, + "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range [0, 1]. + "orientation": "A String", # Detected orientation for the Layout. + "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text. + "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields. + "textSegments": [ # The text segments from the Document.text. + { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset + "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text. + "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text. + }, + ], + }, + }, + }, + ], "detectedLanguages": [ # A list of detected languages together with confidence. { # Detected language for a structural component. "confidence": 3.14, # Confidence of detected language. Range [0, 1]. @@ -885,6 +921,7 @@

Method Details

"metadata": { # Metadata for global schema behavior. # Metadata of the schema. "documentAllowMultipleLabels": True or False, # If true, on a given page, there can be multiple `document` annotations covering it. "documentSplitter": True or False, # If true, a `document` entity type can be applied to subdocument ( splitting). Otherwise, it can only be applied to the entire document (classification). + "prefixedNamingOnProperties": True or False, # If set, all the nested entities must be prefixed with the parents. }, }, "enableSchemaValidation": True or False, # Whether the validation should be performed on the ad-hoc review request. @@ -898,7 +935,7 @@

Method Details

"mentionText": "A String", # Optional. Text value in the document e.g. `1600 Amphitheatre Pkwy`. If the entity is not present in the document, this field will be empty. "nonPresent": True or False, # Optional. This attribute indicates that the processing didn't actually identify this entity, but a confidence score was assigned that represent the potential that this could be a false negative. A non-present entity should have an empty mention_text and text_anchor. "normalizedValue": { # Parsed and normalized entity value. # Optional. Normalized entity value. Absent if the extracted value could not be converted or the type (e.g. address) is not supported for certain parsers. This field is also only populated for certain supported document types. - "addressValue": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Postal address. See also: https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto + "addressValue": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Postal address. See also: https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -1064,6 +1101,42 @@

Method Details

}, }, ], + "detectedBarcodes": [ # A list of detected barcodes. + { # A detected barcode. + "barcode": { # Encodes the detailed information of a barcode. # Detailed barcode information of the DetectedBarcode. + "format": "A String", # Format of a barcode. The supported formats are: CODE_128: Code 128 type. CODE_39: Code 39 type. CODE_93: Code 93 type. CODABAR: Codabar type. DATA_MATRIX: 2D Data Matrix type. ITF: ITF type. EAN_13: EAN-13 type. EAN_8: EAN-8 type. QR_CODE: 2D QR code type. UPC_A: UPC-A type. UPC_E: UPC-E type. PDF417: PDF417 type. AZTEC: 2D Aztec code type. DATABAR: GS1 DataBar code type. + "rawValue": "A String", # Raw value encoded in the barcode. For example, 'MEBKM:TITLE:Google;URL:https://www.google.com;;'. + "valueFormat": "A String", # Value format describes the format of the value that a barcode encodes. The supported formats are: CONTACT_INFO: Contact information. EMAIL: Email address. ISBN: ISBN identifier. PHONE: Phone number. PRODUCT: Product. SMS: SMS message. TEXT: Text string. URL: URL address. WIFI: Wifi information. GEO: Geo-localization. CALENDAR_EVENT: Calendar event. DRIVER_LICENSE: Driver's license. + }, + "layout": { # Visual element describing a layout unit on a page. # Layout for DetectedBarcode. + "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout. + "normalizedVertices": [ # The bounding polygon normalized vertices. + { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1. + "x": 3.14, # X coordinate. + "y": 3.14, # Y coordinate (starts from the top of the image). + }, + ], + "vertices": [ # The bounding polygon vertices. + { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image. + "x": 42, # X coordinate. + "y": 42, # Y coordinate (starts from the top of the image). + }, + ], + }, + "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range [0, 1]. + "orientation": "A String", # Detected orientation for the Layout. + "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text. + "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields. + "textSegments": [ # The text segments from the Document.text. + { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset + "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text. + "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text. + }, + ], + }, + }, + }, + ], "detectedLanguages": [ # A list of detected languages together with confidence. { # Detected language for a structural component. "confidence": 3.14, # Confidence of detected language. Range [0, 1]. diff --git a/docs/dyn/documentai_v1beta3.projects.locations.processors.processorVersions.html b/docs/dyn/documentai_v1beta3.projects.locations.processors.processorVersions.html index a94461565c8..09da9665da7 100644 --- a/docs/dyn/documentai_v1beta3.projects.locations.processors.processorVersions.html +++ b/docs/dyn/documentai_v1beta3.projects.locations.processors.processorVersions.html @@ -351,7 +351,7 @@

Method Details

"mentionText": "A String", # Optional. Text value in the document e.g. `1600 Amphitheatre Pkwy`. If the entity is not present in the document, this field will be empty. "nonPresent": True or False, # Optional. This attribute indicates that the processing didn't actually identify this entity, but a confidence score was assigned that represent the potential that this could be a false negative. A non-present entity should have an empty mention_text and text_anchor. "normalizedValue": { # Parsed and normalized entity value. # Optional. Normalized entity value. Absent if the extracted value could not be converted or the type (e.g. address) is not supported for certain parsers. This field is also only populated for certain supported document types. - "addressValue": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Postal address. See also: https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto + "addressValue": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Postal address. See also: https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -517,6 +517,42 @@

Method Details

}, }, ], + "detectedBarcodes": [ # A list of detected barcodes. + { # A detected barcode. + "barcode": { # Encodes the detailed information of a barcode. # Detailed barcode information of the DetectedBarcode. + "format": "A String", # Format of a barcode. The supported formats are: CODE_128: Code 128 type. CODE_39: Code 39 type. CODE_93: Code 93 type. CODABAR: Codabar type. DATA_MATRIX: 2D Data Matrix type. ITF: ITF type. EAN_13: EAN-13 type. EAN_8: EAN-8 type. QR_CODE: 2D QR code type. UPC_A: UPC-A type. UPC_E: UPC-E type. PDF417: PDF417 type. AZTEC: 2D Aztec code type. DATABAR: GS1 DataBar code type. + "rawValue": "A String", # Raw value encoded in the barcode. For example, 'MEBKM:TITLE:Google;URL:https://www.google.com;;'. + "valueFormat": "A String", # Value format describes the format of the value that a barcode encodes. The supported formats are: CONTACT_INFO: Contact information. EMAIL: Email address. ISBN: ISBN identifier. PHONE: Phone number. PRODUCT: Product. SMS: SMS message. TEXT: Text string. URL: URL address. WIFI: Wifi information. GEO: Geo-localization. CALENDAR_EVENT: Calendar event. DRIVER_LICENSE: Driver's license. + }, + "layout": { # Visual element describing a layout unit on a page. # Layout for DetectedBarcode. + "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout. + "normalizedVertices": [ # The bounding polygon normalized vertices. + { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1. + "x": 3.14, # X coordinate. + "y": 3.14, # Y coordinate (starts from the top of the image). + }, + ], + "vertices": [ # The bounding polygon vertices. + { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image. + "x": 42, # X coordinate. + "y": 42, # Y coordinate (starts from the top of the image). + }, + ], + }, + "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range [0, 1]. + "orientation": "A String", # Detected orientation for the Layout. + "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text. + "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields. + "textSegments": [ # The text segments from the Document.text. + { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset + "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text. + "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text. + }, + ], + }, + }, + }, + ], "detectedLanguages": [ # A list of detected languages together with confidence. { # Detected language for a structural component. "confidence": 3.14, # Confidence of detected language. Range [0, 1]. @@ -1114,7 +1150,7 @@

Method Details

"mentionText": "A String", # Optional. Text value in the document e.g. `1600 Amphitheatre Pkwy`. If the entity is not present in the document, this field will be empty. "nonPresent": True or False, # Optional. This attribute indicates that the processing didn't actually identify this entity, but a confidence score was assigned that represent the potential that this could be a false negative. A non-present entity should have an empty mention_text and text_anchor. "normalizedValue": { # Parsed and normalized entity value. # Optional. Normalized entity value. Absent if the extracted value could not be converted or the type (e.g. address) is not supported for certain parsers. This field is also only populated for certain supported document types. - "addressValue": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Postal address. See also: https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto + "addressValue": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Postal address. See also: https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -1280,6 +1316,42 @@

Method Details

}, }, ], + "detectedBarcodes": [ # A list of detected barcodes. + { # A detected barcode. + "barcode": { # Encodes the detailed information of a barcode. # Detailed barcode information of the DetectedBarcode. + "format": "A String", # Format of a barcode. The supported formats are: CODE_128: Code 128 type. CODE_39: Code 39 type. CODE_93: Code 93 type. CODABAR: Codabar type. DATA_MATRIX: 2D Data Matrix type. ITF: ITF type. EAN_13: EAN-13 type. EAN_8: EAN-8 type. QR_CODE: 2D QR code type. UPC_A: UPC-A type. UPC_E: UPC-E type. PDF417: PDF417 type. AZTEC: 2D Aztec code type. DATABAR: GS1 DataBar code type. + "rawValue": "A String", # Raw value encoded in the barcode. For example, 'MEBKM:TITLE:Google;URL:https://www.google.com;;'. + "valueFormat": "A String", # Value format describes the format of the value that a barcode encodes. The supported formats are: CONTACT_INFO: Contact information. EMAIL: Email address. ISBN: ISBN identifier. PHONE: Phone number. PRODUCT: Product. SMS: SMS message. TEXT: Text string. URL: URL address. WIFI: Wifi information. GEO: Geo-localization. CALENDAR_EVENT: Calendar event. DRIVER_LICENSE: Driver's license. + }, + "layout": { # Visual element describing a layout unit on a page. # Layout for DetectedBarcode. + "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout. + "normalizedVertices": [ # The bounding polygon normalized vertices. + { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1. + "x": 3.14, # X coordinate. + "y": 3.14, # Y coordinate (starts from the top of the image). + }, + ], + "vertices": [ # The bounding polygon vertices. + { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image. + "x": 42, # X coordinate. + "y": 42, # Y coordinate (starts from the top of the image). + }, + ], + }, + "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range [0, 1]. + "orientation": "A String", # Detected orientation for the Layout. + "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text. + "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields. + "textSegments": [ # The text segments from the Document.text. + { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset + "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text. + "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text. + }, + ], + }, + }, + }, + ], "detectedLanguages": [ # A list of detected languages together with confidence. { # Detected language for a structural component. "confidence": 3.14, # Confidence of detected language. Range [0, 1]. @@ -1892,7 +1964,7 @@

Method Details

"mentionText": "A String", # Optional. Text value in the document e.g. `1600 Amphitheatre Pkwy`. If the entity is not present in the document, this field will be empty. "nonPresent": True or False, # Optional. This attribute indicates that the processing didn't actually identify this entity, but a confidence score was assigned that represent the potential that this could be a false negative. A non-present entity should have an empty mention_text and text_anchor. "normalizedValue": { # Parsed and normalized entity value. # Optional. Normalized entity value. Absent if the extracted value could not be converted or the type (e.g. address) is not supported for certain parsers. This field is also only populated for certain supported document types. - "addressValue": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Postal address. See also: https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto + "addressValue": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Postal address. See also: https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -2058,6 +2130,42 @@

Method Details

}, }, ], + "detectedBarcodes": [ # A list of detected barcodes. + { # A detected barcode. + "barcode": { # Encodes the detailed information of a barcode. # Detailed barcode information of the DetectedBarcode. + "format": "A String", # Format of a barcode. The supported formats are: CODE_128: Code 128 type. CODE_39: Code 39 type. CODE_93: Code 93 type. CODABAR: Codabar type. DATA_MATRIX: 2D Data Matrix type. ITF: ITF type. EAN_13: EAN-13 type. EAN_8: EAN-8 type. QR_CODE: 2D QR code type. UPC_A: UPC-A type. UPC_E: UPC-E type. PDF417: PDF417 type. AZTEC: 2D Aztec code type. DATABAR: GS1 DataBar code type. + "rawValue": "A String", # Raw value encoded in the barcode. For example, 'MEBKM:TITLE:Google;URL:https://www.google.com;;'. + "valueFormat": "A String", # Value format describes the format of the value that a barcode encodes. The supported formats are: CONTACT_INFO: Contact information. EMAIL: Email address. ISBN: ISBN identifier. PHONE: Phone number. PRODUCT: Product. SMS: SMS message. TEXT: Text string. URL: URL address. WIFI: Wifi information. GEO: Geo-localization. CALENDAR_EVENT: Calendar event. DRIVER_LICENSE: Driver's license. + }, + "layout": { # Visual element describing a layout unit on a page. # Layout for DetectedBarcode. + "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout. + "normalizedVertices": [ # The bounding polygon normalized vertices. + { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1. + "x": 3.14, # X coordinate. + "y": 3.14, # Y coordinate (starts from the top of the image). + }, + ], + "vertices": [ # The bounding polygon vertices. + { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image. + "x": 42, # X coordinate. + "y": 42, # Y coordinate (starts from the top of the image). + }, + ], + }, + "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range [0, 1]. + "orientation": "A String", # Detected orientation for the Layout. + "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text. + "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields. + "textSegments": [ # The text segments from the Document.text. + { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset + "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text. + "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text. + }, + ], + }, + }, + }, + ], "detectedLanguages": [ # A list of detected languages together with confidence. { # Detected language for a structural component. "confidence": 3.14, # Confidence of detected language. Range [0, 1]. diff --git a/googleapiclient/discovery_cache/documents/documentai.v1.json b/googleapiclient/discovery_cache/documents/documentai.v1.json index a8606010389..78db6b3c03f 100644 --- a/googleapiclient/discovery_cache/documents/documentai.v1.json +++ b/googleapiclient/discovery_cache/documents/documentai.v1.json @@ -326,6 +326,46 @@ } } }, + "processorTypes": { + "methods": { + "list": { + "description": "Lists the processor types that exist.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/processorTypes", + "httpMethod": "GET", + "id": "documentai.projects.locations.processorTypes.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "The maximum number of processor types to return. If unspecified, at most 100 processor types will be returned. The maximum value is 500; values above 500 will be coerced to 500.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Used to retrieve the next page of results, empty if at the end of the list.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The location of processor type to list. The available processor types may depend on the allow-listing on projects. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/processorTypes", + "response": { + "$ref": "GoogleCloudDocumentaiV1ListProcessorTypesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, "processors": { "methods": { "batchProcess": { @@ -1029,7 +1069,7 @@ } } }, - "revision": "20220621", + "revision": "20220711", "rootUrl": "https://documentai.googleapis.com/", "schemas": { "GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadata": { @@ -1606,6 +1646,25 @@ }, "type": "object" }, + "GoogleCloudDocumentaiV1Barcode": { + "description": "Encodes the detailed information of a barcode.", + "id": "GoogleCloudDocumentaiV1Barcode", + "properties": { + "format": { + "description": "Format of a barcode. The supported formats are: CODE_128: Code 128 type. CODE_39: Code 39 type. CODE_93: Code 93 type. CODABAR: Codabar type. DATA_MATRIX: 2D Data Matrix type. ITF: ITF type. EAN_13: EAN-13 type. EAN_8: EAN-8 type. QR_CODE: 2D QR code type. UPC_A: UPC-A type. UPC_E: UPC-E type. PDF417: PDF417 type. AZTEC: 2D Aztec code type. DATABAR: GS1 DataBar code type.", + "type": "string" + }, + "rawValue": { + "description": "Raw value encoded in the barcode. For example, 'MEBKM:TITLE:Google;URL:https://www.google.com;;'.", + "type": "string" + }, + "valueFormat": { + "description": "Value format describes the format of the value that a barcode encodes. The supported formats are: CONTACT_INFO: Contact information. EMAIL: Email address. ISBN: ISBN identifier. PHONE: Phone number. PRODUCT: Product. SMS: SMS message. TEXT: Text string. URL: URL address. WIFI: Wifi information. GEO: Geo-localization. CALENDAR_EVENT: Calendar event. DRIVER_LICENSE: Driver's license.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDocumentaiV1BatchDocumentsInputConfig": { "description": "The common config to specify a set of documents used as input.", "id": "GoogleCloudDocumentaiV1BatchDocumentsInputConfig", @@ -2079,6 +2138,13 @@ }, "type": "array" }, + "detectedBarcodes": { + "description": "A list of detected barcodes.", + "items": { + "$ref": "GoogleCloudDocumentaiV1DocumentPageDetectedBarcode" + }, + "type": "array" + }, "detectedLanguages": { "description": "A list of detected languages together with confidence.", "items": { @@ -2251,6 +2317,21 @@ }, "type": "object" }, + "GoogleCloudDocumentaiV1DocumentPageDetectedBarcode": { + "description": "A detected barcode.", + "id": "GoogleCloudDocumentaiV1DocumentPageDetectedBarcode", + "properties": { + "barcode": { + "$ref": "GoogleCloudDocumentaiV1Barcode", + "description": "Detailed barcode information of the DetectedBarcode." + }, + "layout": { + "$ref": "GoogleCloudDocumentaiV1DocumentPageLayout", + "description": "Layout for DetectedBarcode." + } + }, + "type": "object" + }, "GoogleCloudDocumentaiV1DocumentPageDetectedLanguage": { "description": "Detected language for a structural component.", "id": "GoogleCloudDocumentaiV1DocumentPageDetectedLanguage", @@ -2874,6 +2955,10 @@ "documentSplitter": { "description": "If true, a `document` entity type can be applied to subdocument ( splitting). Otherwise, it can only be applied to the entire document (classification).", "type": "boolean" + }, + "prefixedNamingOnProperties": { + "description": "If set, all the nested entities must be prefixed with the parents.", + "type": "boolean" } }, "type": "object" @@ -3118,6 +3203,24 @@ }, "type": "object" }, + "GoogleCloudDocumentaiV1ListProcessorTypesResponse": { + "description": "Response message for list processor types.", + "id": "GoogleCloudDocumentaiV1ListProcessorTypesResponse", + "properties": { + "nextPageToken": { + "description": "Points to the next page, otherwise empty.", + "type": "string" + }, + "processorTypes": { + "description": "The processor types.", + "items": { + "$ref": "GoogleCloudDocumentaiV1ProcessorType" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudDocumentaiV1ListProcessorVersionsResponse": { "description": "Response message for list processors.", "id": "GoogleCloudDocumentaiV1ListProcessorVersionsResponse", @@ -3629,6 +3732,25 @@ }, "type": "object" }, + "GoogleCloudDocumentaiV1beta1Barcode": { + "description": "Encodes the detailed information of a barcode.", + "id": "GoogleCloudDocumentaiV1beta1Barcode", + "properties": { + "format": { + "description": "Format of a barcode. The supported formats are: CODE_128: Code 128 type. CODE_39: Code 39 type. CODE_93: Code 93 type. CODABAR: Codabar type. DATA_MATRIX: 2D Data Matrix type. ITF: ITF type. EAN_13: EAN-13 type. EAN_8: EAN-8 type. QR_CODE: 2D QR code type. UPC_A: UPC-A type. UPC_E: UPC-E type. PDF417: PDF417 type. AZTEC: 2D Aztec code type. DATABAR: GS1 DataBar code type.", + "type": "string" + }, + "rawValue": { + "description": "Raw value encoded in the barcode. For example, 'MEBKM:TITLE:Google;URL:https://www.google.com;;'.", + "type": "string" + }, + "valueFormat": { + "description": "Value format describes the format of the value that a barcode encodes. The supported formats are: CONTACT_INFO: Contact information. EMAIL: Email address. ISBN: ISBN identifier. PHONE: Phone number. PRODUCT: Product. SMS: SMS message. TEXT: Text string. URL: URL address. WIFI: Wifi information. GEO: Geo-localization. CALENDAR_EVENT: Calendar event. DRIVER_LICENSE: Driver's license.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDocumentaiV1beta1BatchProcessDocumentsResponse": { "description": "Response to an batch document processing request. This is returned in the LRO Operation after the operation is complete.", "id": "GoogleCloudDocumentaiV1beta1BatchProcessDocumentsResponse", @@ -3868,6 +3990,13 @@ }, "type": "array" }, + "detectedBarcodes": { + "description": "A list of detected barcodes.", + "items": { + "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageDetectedBarcode" + }, + "type": "array" + }, "detectedLanguages": { "description": "A list of detected languages together with confidence.", "items": { @@ -4040,6 +4169,21 @@ }, "type": "object" }, + "GoogleCloudDocumentaiV1beta1DocumentPageDetectedBarcode": { + "description": "A detected barcode.", + "id": "GoogleCloudDocumentaiV1beta1DocumentPageDetectedBarcode", + "properties": { + "barcode": { + "$ref": "GoogleCloudDocumentaiV1beta1Barcode", + "description": "Detailed barcode information of the DetectedBarcode." + }, + "layout": { + "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageLayout", + "description": "Layout for DetectedBarcode." + } + }, + "type": "object" + }, "GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage": { "description": "Detected language for a structural component.", "id": "GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage", @@ -4819,6 +4963,25 @@ }, "type": "object" }, + "GoogleCloudDocumentaiV1beta2Barcode": { + "description": "Encodes the detailed information of a barcode.", + "id": "GoogleCloudDocumentaiV1beta2Barcode", + "properties": { + "format": { + "description": "Format of a barcode. The supported formats are: CODE_128: Code 128 type. CODE_39: Code 39 type. CODE_93: Code 93 type. CODABAR: Codabar type. DATA_MATRIX: 2D Data Matrix type. ITF: ITF type. EAN_13: EAN-13 type. EAN_8: EAN-8 type. QR_CODE: 2D QR code type. UPC_A: UPC-A type. UPC_E: UPC-E type. PDF417: PDF417 type. AZTEC: 2D Aztec code type. DATABAR: GS1 DataBar code type.", + "type": "string" + }, + "rawValue": { + "description": "Raw value encoded in the barcode. For example, 'MEBKM:TITLE:Google;URL:https://www.google.com;;'.", + "type": "string" + }, + "valueFormat": { + "description": "Value format describes the format of the value that a barcode encodes. The supported formats are: CONTACT_INFO: Contact information. EMAIL: Email address. ISBN: ISBN identifier. PHONE: Phone number. PRODUCT: Product. SMS: SMS message. TEXT: Text string. URL: URL address. WIFI: Wifi information. GEO: Geo-localization. CALENDAR_EVENT: Calendar event. DRIVER_LICENSE: Driver's license.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDocumentaiV1beta2BatchProcessDocumentsResponse": { "description": "Response to an batch document processing request. This is returned in the LRO Operation after the operation is complete.", "id": "GoogleCloudDocumentaiV1beta2BatchProcessDocumentsResponse", @@ -5085,6 +5248,13 @@ }, "type": "array" }, + "detectedBarcodes": { + "description": "A list of detected barcodes.", + "items": { + "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageDetectedBarcode" + }, + "type": "array" + }, "detectedLanguages": { "description": "A list of detected languages together with confidence.", "items": { @@ -5257,6 +5427,21 @@ }, "type": "object" }, + "GoogleCloudDocumentaiV1beta2DocumentPageDetectedBarcode": { + "description": "A detected barcode.", + "id": "GoogleCloudDocumentaiV1beta2DocumentPageDetectedBarcode", + "properties": { + "barcode": { + "$ref": "GoogleCloudDocumentaiV1beta2Barcode", + "description": "Detailed barcode information of the DetectedBarcode." + }, + "layout": { + "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageLayout", + "description": "Layout for DetectedBarcode." + } + }, + "type": "object" + }, "GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage": { "description": "Detected language for a structural component.", "id": "GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage", @@ -6647,7 +6832,7 @@ "type": "object" }, "GoogleTypePostalAddress": { - "description": "Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478", + "description": "Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478", "id": "GoogleTypePostalAddress", "properties": { "addressLines": { diff --git a/googleapiclient/discovery_cache/documents/documentai.v1beta2.json b/googleapiclient/discovery_cache/documents/documentai.v1beta2.json index fc99f33ea3f..28110a6a063 100644 --- a/googleapiclient/discovery_cache/documents/documentai.v1beta2.json +++ b/googleapiclient/discovery_cache/documents/documentai.v1beta2.json @@ -292,7 +292,7 @@ } } }, - "revision": "20220621", + "revision": "20220711", "rootUrl": "https://documentai.googleapis.com/", "schemas": { "GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadata": { @@ -1233,6 +1233,25 @@ }, "type": "object" }, + "GoogleCloudDocumentaiV1beta1Barcode": { + "description": "Encodes the detailed information of a barcode.", + "id": "GoogleCloudDocumentaiV1beta1Barcode", + "properties": { + "format": { + "description": "Format of a barcode. The supported formats are: CODE_128: Code 128 type. CODE_39: Code 39 type. CODE_93: Code 93 type. CODABAR: Codabar type. DATA_MATRIX: 2D Data Matrix type. ITF: ITF type. EAN_13: EAN-13 type. EAN_8: EAN-8 type. QR_CODE: 2D QR code type. UPC_A: UPC-A type. UPC_E: UPC-E type. PDF417: PDF417 type. AZTEC: 2D Aztec code type. DATABAR: GS1 DataBar code type.", + "type": "string" + }, + "rawValue": { + "description": "Raw value encoded in the barcode. For example, 'MEBKM:TITLE:Google;URL:https://www.google.com;;'.", + "type": "string" + }, + "valueFormat": { + "description": "Value format describes the format of the value that a barcode encodes. The supported formats are: CONTACT_INFO: Contact information. EMAIL: Email address. ISBN: ISBN identifier. PHONE: Phone number. PRODUCT: Product. SMS: SMS message. TEXT: Text string. URL: URL address. WIFI: Wifi information. GEO: Geo-localization. CALENDAR_EVENT: Calendar event. DRIVER_LICENSE: Driver's license.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDocumentaiV1beta1BatchProcessDocumentsResponse": { "description": "Response to an batch document processing request. This is returned in the LRO Operation after the operation is complete.", "id": "GoogleCloudDocumentaiV1beta1BatchProcessDocumentsResponse", @@ -1472,6 +1491,13 @@ }, "type": "array" }, + "detectedBarcodes": { + "description": "A list of detected barcodes.", + "items": { + "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageDetectedBarcode" + }, + "type": "array" + }, "detectedLanguages": { "description": "A list of detected languages together with confidence.", "items": { @@ -1644,6 +1670,21 @@ }, "type": "object" }, + "GoogleCloudDocumentaiV1beta1DocumentPageDetectedBarcode": { + "description": "A detected barcode.", + "id": "GoogleCloudDocumentaiV1beta1DocumentPageDetectedBarcode", + "properties": { + "barcode": { + "$ref": "GoogleCloudDocumentaiV1beta1Barcode", + "description": "Detailed barcode information of the DetectedBarcode." + }, + "layout": { + "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageLayout", + "description": "Layout for DetectedBarcode." + } + }, + "type": "object" + }, "GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage": { "description": "Detected language for a structural component.", "id": "GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage", @@ -2434,6 +2475,25 @@ }, "type": "object" }, + "GoogleCloudDocumentaiV1beta2Barcode": { + "description": "Encodes the detailed information of a barcode.", + "id": "GoogleCloudDocumentaiV1beta2Barcode", + "properties": { + "format": { + "description": "Format of a barcode. The supported formats are: CODE_128: Code 128 type. CODE_39: Code 39 type. CODE_93: Code 93 type. CODABAR: Codabar type. DATA_MATRIX: 2D Data Matrix type. ITF: ITF type. EAN_13: EAN-13 type. EAN_8: EAN-8 type. QR_CODE: 2D QR code type. UPC_A: UPC-A type. UPC_E: UPC-E type. PDF417: PDF417 type. AZTEC: 2D Aztec code type. DATABAR: GS1 DataBar code type.", + "type": "string" + }, + "rawValue": { + "description": "Raw value encoded in the barcode. For example, 'MEBKM:TITLE:Google;URL:https://www.google.com;;'.", + "type": "string" + }, + "valueFormat": { + "description": "Value format describes the format of the value that a barcode encodes. The supported formats are: CONTACT_INFO: Contact information. EMAIL: Email address. ISBN: ISBN identifier. PHONE: Phone number. PRODUCT: Product. SMS: SMS message. TEXT: Text string. URL: URL address. WIFI: Wifi information. GEO: Geo-localization. CALENDAR_EVENT: Calendar event. DRIVER_LICENSE: Driver's license.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDocumentaiV1beta2BatchProcessDocumentsRequest": { "description": "Request to batch process documents as an asynchronous operation. The output is written to Cloud Storage as JSON in the [Document] format.", "id": "GoogleCloudDocumentaiV1beta2BatchProcessDocumentsRequest", @@ -2714,6 +2774,13 @@ }, "type": "array" }, + "detectedBarcodes": { + "description": "A list of detected barcodes.", + "items": { + "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageDetectedBarcode" + }, + "type": "array" + }, "detectedLanguages": { "description": "A list of detected languages together with confidence.", "items": { @@ -2886,6 +2953,21 @@ }, "type": "object" }, + "GoogleCloudDocumentaiV1beta2DocumentPageDetectedBarcode": { + "description": "A detected barcode.", + "id": "GoogleCloudDocumentaiV1beta2DocumentPageDetectedBarcode", + "properties": { + "barcode": { + "$ref": "GoogleCloudDocumentaiV1beta2Barcode", + "description": "Detailed barcode information of the DetectedBarcode." + }, + "layout": { + "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageLayout", + "description": "Layout for DetectedBarcode." + } + }, + "type": "object" + }, "GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage": { "description": "Detected language for a structural component.", "id": "GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage", @@ -4363,7 +4445,7 @@ "type": "object" }, "GoogleTypePostalAddress": { - "description": "Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478", + "description": "Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478", "id": "GoogleTypePostalAddress", "properties": { "addressLines": { diff --git a/googleapiclient/discovery_cache/documents/documentai.v1beta3.json b/googleapiclient/discovery_cache/documents/documentai.v1beta3.json index 0cd3d5898d7..7882554db8a 100644 --- a/googleapiclient/discovery_cache/documents/documentai.v1beta3.json +++ b/googleapiclient/discovery_cache/documents/documentai.v1beta3.json @@ -297,6 +297,46 @@ } } }, + "processorTypes": { + "methods": { + "list": { + "description": "Lists the processor types that exist.", + "flatPath": "v1beta3/projects/{projectsId}/locations/{locationsId}/processorTypes", + "httpMethod": "GET", + "id": "documentai.projects.locations.processorTypes.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "The maximum number of processor types to return. If unspecified, at most 100 processor types will be returned. The maximum value is 500; values above 500 will be coerced to 500.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Used to retrieve the next page of results, empty if at the end of the list.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The location of processor type to list. The available processor types may depend on the allow-listing on projects. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta3/{+parent}/processorTypes", + "response": { + "$ref": "GoogleCloudDocumentaiV1beta3ListProcessorTypesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, "processors": { "methods": { "batchProcess": { @@ -796,7 +836,7 @@ } } }, - "revision": "20220621", + "revision": "20220711", "rootUrl": "https://documentai.googleapis.com/", "schemas": { "GoogleCloudDocumentaiUiv1beta3BatchDeleteDocumentsMetadata": { @@ -1737,6 +1777,25 @@ }, "type": "object" }, + "GoogleCloudDocumentaiV1beta1Barcode": { + "description": "Encodes the detailed information of a barcode.", + "id": "GoogleCloudDocumentaiV1beta1Barcode", + "properties": { + "format": { + "description": "Format of a barcode. The supported formats are: CODE_128: Code 128 type. CODE_39: Code 39 type. CODE_93: Code 93 type. CODABAR: Codabar type. DATA_MATRIX: 2D Data Matrix type. ITF: ITF type. EAN_13: EAN-13 type. EAN_8: EAN-8 type. QR_CODE: 2D QR code type. UPC_A: UPC-A type. UPC_E: UPC-E type. PDF417: PDF417 type. AZTEC: 2D Aztec code type. DATABAR: GS1 DataBar code type.", + "type": "string" + }, + "rawValue": { + "description": "Raw value encoded in the barcode. For example, 'MEBKM:TITLE:Google;URL:https://www.google.com;;'.", + "type": "string" + }, + "valueFormat": { + "description": "Value format describes the format of the value that a barcode encodes. The supported formats are: CONTACT_INFO: Contact information. EMAIL: Email address. ISBN: ISBN identifier. PHONE: Phone number. PRODUCT: Product. SMS: SMS message. TEXT: Text string. URL: URL address. WIFI: Wifi information. GEO: Geo-localization. CALENDAR_EVENT: Calendar event. DRIVER_LICENSE: Driver's license.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDocumentaiV1beta1BatchProcessDocumentsResponse": { "description": "Response to an batch document processing request. This is returned in the LRO Operation after the operation is complete.", "id": "GoogleCloudDocumentaiV1beta1BatchProcessDocumentsResponse", @@ -1976,6 +2035,13 @@ }, "type": "array" }, + "detectedBarcodes": { + "description": "A list of detected barcodes.", + "items": { + "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageDetectedBarcode" + }, + "type": "array" + }, "detectedLanguages": { "description": "A list of detected languages together with confidence.", "items": { @@ -2148,6 +2214,21 @@ }, "type": "object" }, + "GoogleCloudDocumentaiV1beta1DocumentPageDetectedBarcode": { + "description": "A detected barcode.", + "id": "GoogleCloudDocumentaiV1beta1DocumentPageDetectedBarcode", + "properties": { + "barcode": { + "$ref": "GoogleCloudDocumentaiV1beta1Barcode", + "description": "Detailed barcode information of the DetectedBarcode." + }, + "layout": { + "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageLayout", + "description": "Layout for DetectedBarcode." + } + }, + "type": "object" + }, "GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage": { "description": "Detected language for a structural component.", "id": "GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage", @@ -2927,6 +3008,25 @@ }, "type": "object" }, + "GoogleCloudDocumentaiV1beta2Barcode": { + "description": "Encodes the detailed information of a barcode.", + "id": "GoogleCloudDocumentaiV1beta2Barcode", + "properties": { + "format": { + "description": "Format of a barcode. The supported formats are: CODE_128: Code 128 type. CODE_39: Code 39 type. CODE_93: Code 93 type. CODABAR: Codabar type. DATA_MATRIX: 2D Data Matrix type. ITF: ITF type. EAN_13: EAN-13 type. EAN_8: EAN-8 type. QR_CODE: 2D QR code type. UPC_A: UPC-A type. UPC_E: UPC-E type. PDF417: PDF417 type. AZTEC: 2D Aztec code type. DATABAR: GS1 DataBar code type.", + "type": "string" + }, + "rawValue": { + "description": "Raw value encoded in the barcode. For example, 'MEBKM:TITLE:Google;URL:https://www.google.com;;'.", + "type": "string" + }, + "valueFormat": { + "description": "Value format describes the format of the value that a barcode encodes. The supported formats are: CONTACT_INFO: Contact information. EMAIL: Email address. ISBN: ISBN identifier. PHONE: Phone number. PRODUCT: Product. SMS: SMS message. TEXT: Text string. URL: URL address. WIFI: Wifi information. GEO: Geo-localization. CALENDAR_EVENT: Calendar event. DRIVER_LICENSE: Driver's license.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDocumentaiV1beta2BatchProcessDocumentsResponse": { "description": "Response to an batch document processing request. This is returned in the LRO Operation after the operation is complete.", "id": "GoogleCloudDocumentaiV1beta2BatchProcessDocumentsResponse", @@ -3193,6 +3293,13 @@ }, "type": "array" }, + "detectedBarcodes": { + "description": "A list of detected barcodes.", + "items": { + "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageDetectedBarcode" + }, + "type": "array" + }, "detectedLanguages": { "description": "A list of detected languages together with confidence.", "items": { @@ -3365,6 +3472,21 @@ }, "type": "object" }, + "GoogleCloudDocumentaiV1beta2DocumentPageDetectedBarcode": { + "description": "A detected barcode.", + "id": "GoogleCloudDocumentaiV1beta2DocumentPageDetectedBarcode", + "properties": { + "barcode": { + "$ref": "GoogleCloudDocumentaiV1beta2Barcode", + "description": "Detailed barcode information of the DetectedBarcode." + }, + "layout": { + "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageLayout", + "description": "Layout for DetectedBarcode." + } + }, + "type": "object" + }, "GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage": { "description": "Detected language for a structural component.", "id": "GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage", @@ -4149,6 +4271,25 @@ }, "type": "object" }, + "GoogleCloudDocumentaiV1beta3Barcode": { + "description": "Encodes the detailed information of a barcode.", + "id": "GoogleCloudDocumentaiV1beta3Barcode", + "properties": { + "format": { + "description": "Format of a barcode. The supported formats are: CODE_128: Code 128 type. CODE_39: Code 39 type. CODE_93: Code 93 type. CODABAR: Codabar type. DATA_MATRIX: 2D Data Matrix type. ITF: ITF type. EAN_13: EAN-13 type. EAN_8: EAN-8 type. QR_CODE: 2D QR code type. UPC_A: UPC-A type. UPC_E: UPC-E type. PDF417: PDF417 type. AZTEC: 2D Aztec code type. DATABAR: GS1 DataBar code type.", + "type": "string" + }, + "rawValue": { + "description": "Raw value encoded in the barcode. For example, 'MEBKM:TITLE:Google;URL:https://www.google.com;;'.", + "type": "string" + }, + "valueFormat": { + "description": "Value format describes the format of the value that a barcode encodes. The supported formats are: CONTACT_INFO: Contact information. EMAIL: Email address. ISBN: ISBN identifier. PHONE: Phone number. PRODUCT: Product. SMS: SMS message. TEXT: Text string. URL: URL address. WIFI: Wifi information. GEO: Geo-localization. CALENDAR_EVENT: Calendar event. DRIVER_LICENSE: Driver's license.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDocumentaiV1beta3BatchDocumentsInputConfig": { "description": "The common config to specify a set of documents used as input.", "id": "GoogleCloudDocumentaiV1beta3BatchDocumentsInputConfig", @@ -4663,6 +4804,13 @@ }, "type": "array" }, + "detectedBarcodes": { + "description": "A list of detected barcodes.", + "items": { + "$ref": "GoogleCloudDocumentaiV1beta3DocumentPageDetectedBarcode" + }, + "type": "array" + }, "detectedLanguages": { "description": "A list of detected languages together with confidence.", "items": { @@ -4835,6 +4983,21 @@ }, "type": "object" }, + "GoogleCloudDocumentaiV1beta3DocumentPageDetectedBarcode": { + "description": "A detected barcode.", + "id": "GoogleCloudDocumentaiV1beta3DocumentPageDetectedBarcode", + "properties": { + "barcode": { + "$ref": "GoogleCloudDocumentaiV1beta3Barcode", + "description": "Detailed barcode information of the DetectedBarcode." + }, + "layout": { + "$ref": "GoogleCloudDocumentaiV1beta3DocumentPageLayout", + "description": "Layout for DetectedBarcode." + } + }, + "type": "object" + }, "GoogleCloudDocumentaiV1beta3DocumentPageDetectedLanguage": { "description": "Detected language for a structural component.", "id": "GoogleCloudDocumentaiV1beta3DocumentPageDetectedLanguage", @@ -5458,6 +5621,10 @@ "documentSplitter": { "description": "If true, a `document` entity type can be applied to subdocument ( splitting). Otherwise, it can only be applied to the entire document (classification).", "type": "boolean" + }, + "prefixedNamingOnProperties": { + "description": "If set, all the nested entities must be prefixed with the parents.", + "type": "boolean" } }, "type": "object" @@ -5702,6 +5869,24 @@ }, "type": "object" }, + "GoogleCloudDocumentaiV1beta3ListProcessorTypesResponse": { + "description": "Response message for list processor types.", + "id": "GoogleCloudDocumentaiV1beta3ListProcessorTypesResponse", + "properties": { + "nextPageToken": { + "description": "Points to the next page, otherwise empty.", + "type": "string" + }, + "processorTypes": { + "description": "The processor types.", + "items": { + "$ref": "GoogleCloudDocumentaiV1beta3ProcessorType" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudDocumentaiV1beta3ListProcessorVersionsResponse": { "description": "Response message for list processors.", "id": "GoogleCloudDocumentaiV1beta3ListProcessorVersionsResponse", @@ -6463,7 +6648,7 @@ "type": "object" }, "GoogleTypePostalAddress": { - "description": "Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478", + "description": "Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478", "id": "GoogleTypePostalAddress", "properties": { "addressLines": { From a0d5f488f457dc3be364a573ce4e610b1923d790 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 19 Jul 2022 07:08:13 +0000 Subject: [PATCH 15/23] feat(drive): update the api #### drive:v2 The following keys were added: - resources.changes.methods.list.parameters.includeLabels (Total Keys: 2) - resources.changes.methods.watch.parameters.includeLabels (Total Keys: 2) - resources.files.methods.copy.parameters.includeLabels (Total Keys: 2) - resources.files.methods.get.parameters.includeLabels (Total Keys: 2) - resources.files.methods.insert.parameters.includeLabels (Total Keys: 2) - resources.files.methods.list.parameters.includeLabels (Total Keys: 2) - resources.files.methods.listLabels (Total Keys: 17) - resources.files.methods.modifyLabels (Total Keys: 10) - resources.files.methods.patch.parameters.includeLabels (Total Keys: 2) - resources.files.methods.touch.parameters.includeLabels (Total Keys: 2) - resources.files.methods.trash.parameters.includeLabels (Total Keys: 2) - resources.files.methods.untrash.parameters.includeLabels (Total Keys: 2) - resources.files.methods.update.parameters.includeLabels (Total Keys: 2) - resources.files.methods.watch.parameters.includeLabels (Total Keys: 2) - schemas.File.properties.capabilities.properties.canModifyLabels.type (Total Keys: 1) - schemas.File.properties.capabilities.properties.canReadLabels.type (Total Keys: 1) - schemas.File.properties.labelInfo (Total Keys: 3) - schemas.Label (Total Keys: 59) - schemas.ModifyLabelsRequest (Total Keys: 6) - schemas.ModifyLabelsResponse (Total Keys: 6) #### drive:v3 The following keys were added: - resources.changes.methods.list.parameters.includeLabels (Total Keys: 2) - resources.changes.methods.watch.parameters.includeLabels (Total Keys: 2) - resources.files.methods.copy.parameters.includeLabels (Total Keys: 2) - resources.files.methods.create.parameters.includeLabels (Total Keys: 2) - resources.files.methods.get.parameters.includeLabels (Total Keys: 2) - resources.files.methods.list.parameters.includeLabels (Total Keys: 2) - resources.files.methods.listLabels (Total Keys: 17) - resources.files.methods.modifyLabels (Total Keys: 10) - resources.files.methods.update.parameters.includeLabels (Total Keys: 2) - resources.files.methods.watch.parameters.includeLabels (Total Keys: 2) - schemas.File.properties.capabilities.properties.canModifyLabels.type (Total Keys: 1) - schemas.File.properties.capabilities.properties.canReadLabels.type (Total Keys: 1) - schemas.File.properties.labelInfo (Total Keys: 3) - schemas.Label (Total Keys: 59) - schemas.ModifyLabelsRequest (Total Keys: 6) - schemas.ModifyLabelsResponse (Total Keys: 6) --- docs/dyn/drive_v2.changes.html | 104 ++- docs/dyn/drive_v2.files.html | 849 +++++++++++++++++- docs/dyn/drive_v3.changes.html | 55 +- docs/dyn/drive_v3.files.html | 574 +++++++++++- .../discovery_cache/documents/drive.v2.json | 388 +++++++- .../discovery_cache/documents/drive.v3.json | 368 +++++++- 6 files changed, 2286 insertions(+), 52 deletions(-) diff --git a/docs/dyn/drive_v2.changes.html b/docs/dyn/drive_v2.changes.html index 89025bad460..e6008747c9b 100644 --- a/docs/dyn/drive_v2.changes.html +++ b/docs/dyn/drive_v2.changes.html @@ -84,13 +84,13 @@

Instance Methods

getStartPageToken(driveId=None, supportsAllDrives=None, supportsTeamDrives=None, teamDriveId=None)

Gets the starting pageToken for listing future changes.

- list(driveId=None, includeCorpusRemovals=None, includeDeleted=None, includeItemsFromAllDrives=None, includePermissionsForView=None, includeSubscribed=None, includeTeamDriveItems=None, maxResults=None, pageToken=None, spaces=None, startChangeId=None, supportsAllDrives=None, supportsTeamDrives=None, teamDriveId=None)

+ list(driveId=None, includeCorpusRemovals=None, includeDeleted=None, includeItemsFromAllDrives=None, includeLabels=None, includePermissionsForView=None, includeSubscribed=None, includeTeamDriveItems=None, maxResults=None, pageToken=None, spaces=None, startChangeId=None, supportsAllDrives=None, supportsTeamDrives=None, teamDriveId=None)

Lists the changes for a user or shared drive.

list_next()

Retrieves the next page of results.

- watch(body=None, driveId=None, includeCorpusRemovals=None, includeDeleted=None, includeItemsFromAllDrives=None, includePermissionsForView=None, includeSubscribed=None, includeTeamDriveItems=None, maxResults=None, pageToken=None, spaces=None, startChangeId=None, supportsAllDrives=None, supportsTeamDrives=None, teamDriveId=None)

+ watch(body=None, driveId=None, includeCorpusRemovals=None, includeDeleted=None, includeItemsFromAllDrives=None, includeLabels=None, includePermissionsForView=None, includeSubscribed=None, includeTeamDriveItems=None, maxResults=None, pageToken=None, spaces=None, startChangeId=None, supportsAllDrives=None, supportsTeamDrives=None, teamDriveId=None)

Subscribe to changes for a user.

Method Details

@@ -182,6 +182,7 @@

Method Details

"canListChildren": True or False, # Whether the current user can list the children of this folder. This is always false when the item is not a folder. "canModifyContent": True or False, # Whether the current user can modify the content of this file. "canModifyContentRestriction": True or False, # Whether the current user can modify restrictions on content of this file. + "canModifyLabels": True or False, # Whether the current user can modify the labels on this file. "canMoveChildrenOutOfDrive": True or False, # Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives. "canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead. "canMoveChildrenWithinDrive": True or False, # Whether the current user can move children of this folder within this drive. This is false when the item is not a folder. Note that a request to move the child may still fail depending on the current user's access to the child and to the destination folder. @@ -193,6 +194,7 @@

Method Details

"canMoveItemWithinTeamDrive": True or False, # Deprecated - use canMoveItemWithinDrive instead. "canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead. "canReadDrive": True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives. + "canReadLabels": True or False, # Whether the current user can read the labels on this file. "canReadRevisions": True or False, # Whether the current user can read the revisions resource of this file. For a shared drive item, whether revisions of non-folder descendants of this item, or this item itself if it is not a folder, can be read. "canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead. "canRemoveChildren": True or False, # Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use canDeleteChildren or canTrashChildren instead. @@ -276,6 +278,51 @@

Method Details

}, "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app. "kind": "drive#file", # The type of file. This is always drive#file. + "labelInfo": { # An overview of the labels on the file. + "labels": [ # The set of labels on the file as requested by the label IDs in the includeLabels parameter. By default, no labels are returned. + { # Representation of a label and its fields. + "fields": { # A map of the label's fields keyed by the field ID. + "a_key": { # Representation of a label field. + "dateString": [ # Only present if valueType is dateString. RFC 3339 formatted date: YYYY-MM-DD. + "A String", + ], + "id": "A String", # The identifier of this field. + "integer": [ # Only present if valueType is integer. + "A String", + ], + "kind": "drive#labelField", # This is always drive#labelField. + "selection": [ # Only present if valueType is selection. + "A String", + ], + "text": [ # Only present if valueType is text. + "A String", + ], + "user": [ # Only present if valueType is user. + { # Information about a Drive user. + "displayName": "A String", # A plain text displayable name for this user. + "emailAddress": "A String", # The email address of the user. + "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # This is always drive#user. + "permissionId": "A String", # The user's ID as visible in the permissions collection. + "picture": { # The user's profile picture. + "url": "A String", # A URL that points to a profile picture of this user. + }, + }, + ], + "valueType": "A String", # The field type. While new values may be supported in the future, the following are currently allowed: + # - dateString + # - integer + # - selection + # - text + # - user + }, + }, + "id": "A String", # The ID of the label. + "kind": "drive#label", # This is always drive#label + "revisionId": "A String", # The revision ID of the label. + }, + ], + }, "labels": { # A group of labels for the file. "hidden": True or False, # Deprecated. "modified": True or False, # Whether the file has been modified by this user. @@ -610,7 +657,7 @@

Method Details

- list(driveId=None, includeCorpusRemovals=None, includeDeleted=None, includeItemsFromAllDrives=None, includePermissionsForView=None, includeSubscribed=None, includeTeamDriveItems=None, maxResults=None, pageToken=None, spaces=None, startChangeId=None, supportsAllDrives=None, supportsTeamDrives=None, teamDriveId=None) + list(driveId=None, includeCorpusRemovals=None, includeDeleted=None, includeItemsFromAllDrives=None, includeLabels=None, includePermissionsForView=None, includeSubscribed=None, includeTeamDriveItems=None, maxResults=None, pageToken=None, spaces=None, startChangeId=None, supportsAllDrives=None, supportsTeamDrives=None, teamDriveId=None)
Lists the changes for a user or shared drive.
 
 Args:
@@ -618,6 +665,7 @@ 

Method Details

includeCorpusRemovals: boolean, Whether changes should include the file resource if the file is still accessible by the user at the time of the request, even when a file was removed from the list of changes and there will be no further change entries for this file. includeDeleted: boolean, Whether to include changes indicating that items have been removed from the list of changes, for example by deletion or loss of access. includeItemsFromAllDrives: boolean, Whether both My Drive and shared drive items should be included in results. + includeLabels: string, A comma-separated list of IDs of labels to include in the labelInfo part of the response. includePermissionsForView: string, Specifies which additional view's permissions to include in the response. Only 'published' is supported. includeSubscribed: boolean, Whether to include changes outside the My Drive hierarchy in the result. When set to false, changes to files such as those in the Application Data folder or shared files which have not been added to My Drive are omitted from the result. includeTeamDriveItems: boolean, Deprecated use includeItemsFromAllDrives instead. @@ -705,6 +753,7 @@

Method Details

"canListChildren": True or False, # Whether the current user can list the children of this folder. This is always false when the item is not a folder. "canModifyContent": True or False, # Whether the current user can modify the content of this file. "canModifyContentRestriction": True or False, # Whether the current user can modify restrictions on content of this file. + "canModifyLabels": True or False, # Whether the current user can modify the labels on this file. "canMoveChildrenOutOfDrive": True or False, # Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives. "canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead. "canMoveChildrenWithinDrive": True or False, # Whether the current user can move children of this folder within this drive. This is false when the item is not a folder. Note that a request to move the child may still fail depending on the current user's access to the child and to the destination folder. @@ -716,6 +765,7 @@

Method Details

"canMoveItemWithinTeamDrive": True or False, # Deprecated - use canMoveItemWithinDrive instead. "canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead. "canReadDrive": True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives. + "canReadLabels": True or False, # Whether the current user can read the labels on this file. "canReadRevisions": True or False, # Whether the current user can read the revisions resource of this file. For a shared drive item, whether revisions of non-folder descendants of this item, or this item itself if it is not a folder, can be read. "canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead. "canRemoveChildren": True or False, # Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use canDeleteChildren or canTrashChildren instead. @@ -799,6 +849,51 @@

Method Details

}, "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app. "kind": "drive#file", # The type of file. This is always drive#file. + "labelInfo": { # An overview of the labels on the file. + "labels": [ # The set of labels on the file as requested by the label IDs in the includeLabels parameter. By default, no labels are returned. + { # Representation of a label and its fields. + "fields": { # A map of the label's fields keyed by the field ID. + "a_key": { # Representation of a label field. + "dateString": [ # Only present if valueType is dateString. RFC 3339 formatted date: YYYY-MM-DD. + "A String", + ], + "id": "A String", # The identifier of this field. + "integer": [ # Only present if valueType is integer. + "A String", + ], + "kind": "drive#labelField", # This is always drive#labelField. + "selection": [ # Only present if valueType is selection. + "A String", + ], + "text": [ # Only present if valueType is text. + "A String", + ], + "user": [ # Only present if valueType is user. + { # Information about a Drive user. + "displayName": "A String", # A plain text displayable name for this user. + "emailAddress": "A String", # The email address of the user. + "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # This is always drive#user. + "permissionId": "A String", # The user's ID as visible in the permissions collection. + "picture": { # The user's profile picture. + "url": "A String", # A URL that points to a profile picture of this user. + }, + }, + ], + "valueType": "A String", # The field type. While new values may be supported in the future, the following are currently allowed: + # - dateString + # - integer + # - selection + # - text + # - user + }, + }, + "id": "A String", # The ID of the label. + "kind": "drive#label", # This is always drive#label + "revisionId": "A String", # The revision ID of the label. + }, + ], + }, "labels": { # A group of labels for the file. "hidden": True or False, # Deprecated. "modified": True or False, # Whether the file has been modified by this user. @@ -1136,7 +1231,7 @@

Method Details

- watch(body=None, driveId=None, includeCorpusRemovals=None, includeDeleted=None, includeItemsFromAllDrives=None, includePermissionsForView=None, includeSubscribed=None, includeTeamDriveItems=None, maxResults=None, pageToken=None, spaces=None, startChangeId=None, supportsAllDrives=None, supportsTeamDrives=None, teamDriveId=None) + watch(body=None, driveId=None, includeCorpusRemovals=None, includeDeleted=None, includeItemsFromAllDrives=None, includeLabels=None, includePermissionsForView=None, includeSubscribed=None, includeTeamDriveItems=None, maxResults=None, pageToken=None, spaces=None, startChangeId=None, supportsAllDrives=None, supportsTeamDrives=None, teamDriveId=None)
Subscribe to changes for a user.
 
 Args:
@@ -1162,6 +1257,7 @@ 

Method Details

includeCorpusRemovals: boolean, Whether changes should include the file resource if the file is still accessible by the user at the time of the request, even when a file was removed from the list of changes and there will be no further change entries for this file. includeDeleted: boolean, Whether to include changes indicating that items have been removed from the list of changes, for example by deletion or loss of access. includeItemsFromAllDrives: boolean, Whether both My Drive and shared drive items should be included in results. + includeLabels: string, A comma-separated list of IDs of labels to include in the labelInfo part of the response. includePermissionsForView: string, Specifies which additional view's permissions to include in the response. Only 'published' is supported. includeSubscribed: boolean, Whether to include changes outside the My Drive hierarchy in the result. When set to false, changes to files such as those in the Application Data folder or shared files which have not been added to My Drive are omitted from the result. includeTeamDriveItems: boolean, Deprecated use includeItemsFromAllDrives instead. diff --git a/docs/dyn/drive_v2.files.html b/docs/dyn/drive_v2.files.html index e7bab58d140..61fc17c1ac4 100644 --- a/docs/dyn/drive_v2.files.html +++ b/docs/dyn/drive_v2.files.html @@ -78,7 +78,7 @@

Instance Methods

close()

Close httplib2 connections.

- copy(fileId, body=None, convert=None, enforceSingleParent=None, includePermissionsForView=None, ocr=None, ocrLanguage=None, pinned=None, supportsAllDrives=None, supportsTeamDrives=None, timedTextLanguage=None, timedTextTrackName=None, visibility=None)

+ copy(fileId, body=None, convert=None, enforceSingleParent=None, includeLabels=None, includePermissionsForView=None, ocr=None, ocrLanguage=None, pinned=None, supportsAllDrives=None, supportsTeamDrives=None, timedTextLanguage=None, timedTextTrackName=None, visibility=None)

Creates a copy of the specified file. Folders cannot be copied.

delete(fileId, enforceSingleParent=None, supportsAllDrives=None, supportsTeamDrives=None)

@@ -96,40 +96,49 @@

Instance Methods

generateIds(maxResults=None, space=None, type=None)

Generates a set of file IDs which can be provided in insert or copy requests.

- get(fileId, acknowledgeAbuse=None, includePermissionsForView=None, projection=None, revisionId=None, supportsAllDrives=None, supportsTeamDrives=None, updateViewedDate=None)

+ get(fileId, acknowledgeAbuse=None, includeLabels=None, includePermissionsForView=None, projection=None, revisionId=None, supportsAllDrives=None, supportsTeamDrives=None, updateViewedDate=None)

Gets a file's metadata or content by ID.

- get_media(fileId, acknowledgeAbuse=None, includePermissionsForView=None, projection=None, revisionId=None, supportsAllDrives=None, supportsTeamDrives=None, updateViewedDate=None)

+ get_media(fileId, acknowledgeAbuse=None, includeLabels=None, includePermissionsForView=None, projection=None, revisionId=None, supportsAllDrives=None, supportsTeamDrives=None, updateViewedDate=None)

Gets a file's metadata or content by ID.

- insert(body=None, convert=None, enforceSingleParent=None, includePermissionsForView=None, media_body=None, media_mime_type=None, ocr=None, ocrLanguage=None, pinned=None, supportsAllDrives=None, supportsTeamDrives=None, timedTextLanguage=None, timedTextTrackName=None, useContentAsIndexableText=None, visibility=None)

+ insert(body=None, convert=None, enforceSingleParent=None, includeLabels=None, includePermissionsForView=None, media_body=None, media_mime_type=None, ocr=None, ocrLanguage=None, pinned=None, supportsAllDrives=None, supportsTeamDrives=None, timedTextLanguage=None, timedTextTrackName=None, useContentAsIndexableText=None, visibility=None)

Insert a new file.

- list(corpora=None, corpus=None, driveId=None, includeItemsFromAllDrives=None, includePermissionsForView=None, includeTeamDriveItems=None, maxResults=None, orderBy=None, pageToken=None, projection=None, q=None, spaces=None, supportsAllDrives=None, supportsTeamDrives=None, teamDriveId=None)

+ list(corpora=None, corpus=None, driveId=None, includeItemsFromAllDrives=None, includeLabels=None, includePermissionsForView=None, includeTeamDriveItems=None, maxResults=None, orderBy=None, pageToken=None, projection=None, q=None, spaces=None, supportsAllDrives=None, supportsTeamDrives=None, teamDriveId=None)

Lists the user's files.

+

+ listLabels(fileId, maxResults=None, pageToken=None)

+

Lists the labels on a file.

+

+ listLabels_next()

+

Retrieves the next page of results.

list_next()

Retrieves the next page of results.

- patch(fileId, addParents=None, body=None, convert=None, enforceSingleParent=None, includePermissionsForView=None, modifiedDateBehavior=None, newRevision=None, ocr=None, ocrLanguage=None, pinned=None, removeParents=None, setModifiedDate=None, supportsAllDrives=None, supportsTeamDrives=None, timedTextLanguage=None, timedTextTrackName=None, updateViewedDate=None, useContentAsIndexableText=None)

+ modifyLabels(fileId, body=None)

+

Modifies the set of labels on a file.

+

+ patch(fileId, addParents=None, body=None, convert=None, enforceSingleParent=None, includeLabels=None, includePermissionsForView=None, modifiedDateBehavior=None, newRevision=None, ocr=None, ocrLanguage=None, pinned=None, removeParents=None, setModifiedDate=None, supportsAllDrives=None, supportsTeamDrives=None, timedTextLanguage=None, timedTextTrackName=None, updateViewedDate=None, useContentAsIndexableText=None)

Updates a file's metadata and/or content. When calling this method, only populate fields in the request that you want to modify. When updating fields, some fields might change automatically, such as modifiedDate. This method supports patch semantics.

- touch(fileId, includePermissionsForView=None, supportsAllDrives=None, supportsTeamDrives=None)

+ touch(fileId, includeLabels=None, includePermissionsForView=None, supportsAllDrives=None, supportsTeamDrives=None)

Set the file's updated time to the current server time.

- trash(fileId, includePermissionsForView=None, supportsAllDrives=None, supportsTeamDrives=None)

+ trash(fileId, includeLabels=None, includePermissionsForView=None, supportsAllDrives=None, supportsTeamDrives=None)

Moves a file to the trash. The currently authenticated user must own the file or be at least a fileOrganizer on the parent for shared drive files. Only the owner may trash a file. The trashed item is excluded from all files.list responses returned for any user who does not own the file. However, all users with access to the file can see the trashed item metadata in an API response. All users with access can copy, download, export, and share the file.

- untrash(fileId, includePermissionsForView=None, supportsAllDrives=None, supportsTeamDrives=None)

+ untrash(fileId, includeLabels=None, includePermissionsForView=None, supportsAllDrives=None, supportsTeamDrives=None)

Restores a file from the trash. The currently authenticated user must own the file or be at least a fileOrganizer on the parent for shared drive files. Only the owner may untrash a file.

- update(fileId, addParents=None, body=None, convert=None, enforceSingleParent=None, includePermissionsForView=None, media_body=None, media_mime_type=None, modifiedDateBehavior=None, newRevision=None, ocr=None, ocrLanguage=None, pinned=None, removeParents=None, setModifiedDate=None, supportsAllDrives=None, supportsTeamDrives=None, timedTextLanguage=None, timedTextTrackName=None, updateViewedDate=None, useContentAsIndexableText=None)

+ update(fileId, addParents=None, body=None, convert=None, enforceSingleParent=None, includeLabels=None, includePermissionsForView=None, media_body=None, media_mime_type=None, modifiedDateBehavior=None, newRevision=None, ocr=None, ocrLanguage=None, pinned=None, removeParents=None, setModifiedDate=None, supportsAllDrives=None, supportsTeamDrives=None, timedTextLanguage=None, timedTextTrackName=None, updateViewedDate=None, useContentAsIndexableText=None)

Updates a file's metadata and/or content. When calling this method, only populate fields in the request that you want to modify. When updating fields, some fields might be changed automatically, such as modifiedDate. This method supports patch semantics.

- watch(fileId, acknowledgeAbuse=None, body=None, includePermissionsForView=None, projection=None, revisionId=None, supportsAllDrives=None, supportsTeamDrives=None, updateViewedDate=None)

+ watch(fileId, acknowledgeAbuse=None, body=None, includeLabels=None, includePermissionsForView=None, projection=None, revisionId=None, supportsAllDrives=None, supportsTeamDrives=None, updateViewedDate=None)

Subscribes to changes to a file. While you can establish a channel for changes to a file on a shared drive, a change to a shared drive file won't create a notification.

- watch_media(fileId, acknowledgeAbuse=None, body=None, includePermissionsForView=None, projection=None, revisionId=None, supportsAllDrives=None, supportsTeamDrives=None, updateViewedDate=None)

+ watch_media(fileId, acknowledgeAbuse=None, body=None, includeLabels=None, includePermissionsForView=None, projection=None, revisionId=None, supportsAllDrives=None, supportsTeamDrives=None, updateViewedDate=None)

Subscribes to changes to a file. While you can establish a channel for changes to a file on a shared drive, a change to a shared drive file won't create a notification.

Method Details

@@ -138,7 +147,7 @@

Method Details

- copy(fileId, body=None, convert=None, enforceSingleParent=None, includePermissionsForView=None, ocr=None, ocrLanguage=None, pinned=None, supportsAllDrives=None, supportsTeamDrives=None, timedTextLanguage=None, timedTextTrackName=None, visibility=None) + copy(fileId, body=None, convert=None, enforceSingleParent=None, includeLabels=None, includePermissionsForView=None, ocr=None, ocrLanguage=None, pinned=None, supportsAllDrives=None, supportsTeamDrives=None, timedTextLanguage=None, timedTextTrackName=None, visibility=None)
Creates a copy of the specified file. Folders cannot be copied.
 
 Args:
@@ -168,6 +177,7 @@ 

Method Details

"canListChildren": True or False, # Whether the current user can list the children of this folder. This is always false when the item is not a folder. "canModifyContent": True or False, # Whether the current user can modify the content of this file. "canModifyContentRestriction": True or False, # Whether the current user can modify restrictions on content of this file. + "canModifyLabels": True or False, # Whether the current user can modify the labels on this file. "canMoveChildrenOutOfDrive": True or False, # Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives. "canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead. "canMoveChildrenWithinDrive": True or False, # Whether the current user can move children of this folder within this drive. This is false when the item is not a folder. Note that a request to move the child may still fail depending on the current user's access to the child and to the destination folder. @@ -179,6 +189,7 @@

Method Details

"canMoveItemWithinTeamDrive": True or False, # Deprecated - use canMoveItemWithinDrive instead. "canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead. "canReadDrive": True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives. + "canReadLabels": True or False, # Whether the current user can read the labels on this file. "canReadRevisions": True or False, # Whether the current user can read the revisions resource of this file. For a shared drive item, whether revisions of non-folder descendants of this item, or this item itself if it is not a folder, can be read. "canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead. "canRemoveChildren": True or False, # Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use canDeleteChildren or canTrashChildren instead. @@ -262,6 +273,51 @@

Method Details

}, "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app. "kind": "drive#file", # The type of file. This is always drive#file. + "labelInfo": { # An overview of the labels on the file. + "labels": [ # The set of labels on the file as requested by the label IDs in the includeLabels parameter. By default, no labels are returned. + { # Representation of a label and its fields. + "fields": { # A map of the label's fields keyed by the field ID. + "a_key": { # Representation of a label field. + "dateString": [ # Only present if valueType is dateString. RFC 3339 formatted date: YYYY-MM-DD. + "A String", + ], + "id": "A String", # The identifier of this field. + "integer": [ # Only present if valueType is integer. + "A String", + ], + "kind": "drive#labelField", # This is always drive#labelField. + "selection": [ # Only present if valueType is selection. + "A String", + ], + "text": [ # Only present if valueType is text. + "A String", + ], + "user": [ # Only present if valueType is user. + { # Information about a Drive user. + "displayName": "A String", # A plain text displayable name for this user. + "emailAddress": "A String", # The email address of the user. + "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # This is always drive#user. + "permissionId": "A String", # The user's ID as visible in the permissions collection. + "picture": { # The user's profile picture. + "url": "A String", # A URL that points to a profile picture of this user. + }, + }, + ], + "valueType": "A String", # The field type. While new values may be supported in the future, the following are currently allowed: + # - dateString + # - integer + # - selection + # - text + # - user + }, + }, + "id": "A String", # The ID of the label. + "kind": "drive#label", # This is always drive#label + "revisionId": "A String", # The revision ID of the label. + }, + ], + }, "labels": { # A group of labels for the file. "hidden": True or False, # Deprecated. "modified": True or False, # Whether the file has been modified by this user. @@ -525,6 +581,7 @@

Method Details

convert: boolean, Whether to convert this file to the corresponding Docs Editors format. enforceSingleParent: boolean, Deprecated. Copying files into multiple folders is no longer supported. Use shortcuts instead. + includeLabels: string, A comma-separated list of IDs of labels to include in the labelInfo part of the response. includePermissionsForView: string, Specifies which additional view's permissions to include in the response. Only 'published' is supported. ocr: boolean, Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads. ocrLanguage: string, If ocr is true, hints at the language to use. Valid values are BCP 47 codes. @@ -563,6 +620,7 @@

Method Details

"canListChildren": True or False, # Whether the current user can list the children of this folder. This is always false when the item is not a folder. "canModifyContent": True or False, # Whether the current user can modify the content of this file. "canModifyContentRestriction": True or False, # Whether the current user can modify restrictions on content of this file. + "canModifyLabels": True or False, # Whether the current user can modify the labels on this file. "canMoveChildrenOutOfDrive": True or False, # Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives. "canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead. "canMoveChildrenWithinDrive": True or False, # Whether the current user can move children of this folder within this drive. This is false when the item is not a folder. Note that a request to move the child may still fail depending on the current user's access to the child and to the destination folder. @@ -574,6 +632,7 @@

Method Details

"canMoveItemWithinTeamDrive": True or False, # Deprecated - use canMoveItemWithinDrive instead. "canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead. "canReadDrive": True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives. + "canReadLabels": True or False, # Whether the current user can read the labels on this file. "canReadRevisions": True or False, # Whether the current user can read the revisions resource of this file. For a shared drive item, whether revisions of non-folder descendants of this item, or this item itself if it is not a folder, can be read. "canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead. "canRemoveChildren": True or False, # Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use canDeleteChildren or canTrashChildren instead. @@ -657,6 +716,51 @@

Method Details

}, "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app. "kind": "drive#file", # The type of file. This is always drive#file. + "labelInfo": { # An overview of the labels on the file. + "labels": [ # The set of labels on the file as requested by the label IDs in the includeLabels parameter. By default, no labels are returned. + { # Representation of a label and its fields. + "fields": { # A map of the label's fields keyed by the field ID. + "a_key": { # Representation of a label field. + "dateString": [ # Only present if valueType is dateString. RFC 3339 formatted date: YYYY-MM-DD. + "A String", + ], + "id": "A String", # The identifier of this field. + "integer": [ # Only present if valueType is integer. + "A String", + ], + "kind": "drive#labelField", # This is always drive#labelField. + "selection": [ # Only present if valueType is selection. + "A String", + ], + "text": [ # Only present if valueType is text. + "A String", + ], + "user": [ # Only present if valueType is user. + { # Information about a Drive user. + "displayName": "A String", # A plain text displayable name for this user. + "emailAddress": "A String", # The email address of the user. + "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # This is always drive#user. + "permissionId": "A String", # The user's ID as visible in the permissions collection. + "picture": { # The user's profile picture. + "url": "A String", # A URL that points to a profile picture of this user. + }, + }, + ], + "valueType": "A String", # The field type. While new values may be supported in the future, the following are currently allowed: + # - dateString + # - integer + # - selection + # - text + # - user + }, + }, + "id": "A String", # The ID of the label. + "kind": "drive#label", # This is always drive#label + "revisionId": "A String", # The revision ID of the label. + }, + ], + }, "labels": { # A group of labels for the file. "hidden": True or False, # Deprecated. "modified": True or False, # Whether the file has been modified by this user. @@ -982,12 +1086,13 @@

Method Details

- get(fileId, acknowledgeAbuse=None, includePermissionsForView=None, projection=None, revisionId=None, supportsAllDrives=None, supportsTeamDrives=None, updateViewedDate=None) + get(fileId, acknowledgeAbuse=None, includeLabels=None, includePermissionsForView=None, projection=None, revisionId=None, supportsAllDrives=None, supportsTeamDrives=None, updateViewedDate=None)
Gets a file's metadata or content by ID.
 
 Args:
   fileId: string, The ID for the file in question. (required)
   acknowledgeAbuse: boolean, Whether the user is acknowledging the risk of downloading known malware or other abusive files.
+  includeLabels: string, A comma-separated list of IDs of labels to include in the labelInfo part of the response.
   includePermissionsForView: string, Specifies which additional view's permissions to include in the response. Only 'published' is supported.
   projection: string, This parameter is deprecated and has no function.
     Allowed values
@@ -1023,6 +1128,7 @@ 

Method Details

"canListChildren": True or False, # Whether the current user can list the children of this folder. This is always false when the item is not a folder. "canModifyContent": True or False, # Whether the current user can modify the content of this file. "canModifyContentRestriction": True or False, # Whether the current user can modify restrictions on content of this file. + "canModifyLabels": True or False, # Whether the current user can modify the labels on this file. "canMoveChildrenOutOfDrive": True or False, # Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives. "canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead. "canMoveChildrenWithinDrive": True or False, # Whether the current user can move children of this folder within this drive. This is false when the item is not a folder. Note that a request to move the child may still fail depending on the current user's access to the child and to the destination folder. @@ -1034,6 +1140,7 @@

Method Details

"canMoveItemWithinTeamDrive": True or False, # Deprecated - use canMoveItemWithinDrive instead. "canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead. "canReadDrive": True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives. + "canReadLabels": True or False, # Whether the current user can read the labels on this file. "canReadRevisions": True or False, # Whether the current user can read the revisions resource of this file. For a shared drive item, whether revisions of non-folder descendants of this item, or this item itself if it is not a folder, can be read. "canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead. "canRemoveChildren": True or False, # Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use canDeleteChildren or canTrashChildren instead. @@ -1117,6 +1224,51 @@

Method Details

}, "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app. "kind": "drive#file", # The type of file. This is always drive#file. + "labelInfo": { # An overview of the labels on the file. + "labels": [ # The set of labels on the file as requested by the label IDs in the includeLabels parameter. By default, no labels are returned. + { # Representation of a label and its fields. + "fields": { # A map of the label's fields keyed by the field ID. + "a_key": { # Representation of a label field. + "dateString": [ # Only present if valueType is dateString. RFC 3339 formatted date: YYYY-MM-DD. + "A String", + ], + "id": "A String", # The identifier of this field. + "integer": [ # Only present if valueType is integer. + "A String", + ], + "kind": "drive#labelField", # This is always drive#labelField. + "selection": [ # Only present if valueType is selection. + "A String", + ], + "text": [ # Only present if valueType is text. + "A String", + ], + "user": [ # Only present if valueType is user. + { # Information about a Drive user. + "displayName": "A String", # A plain text displayable name for this user. + "emailAddress": "A String", # The email address of the user. + "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # This is always drive#user. + "permissionId": "A String", # The user's ID as visible in the permissions collection. + "picture": { # The user's profile picture. + "url": "A String", # A URL that points to a profile picture of this user. + }, + }, + ], + "valueType": "A String", # The field type. While new values may be supported in the future, the following are currently allowed: + # - dateString + # - integer + # - selection + # - text + # - user + }, + }, + "id": "A String", # The ID of the label. + "kind": "drive#label", # This is always drive#label + "revisionId": "A String", # The revision ID of the label. + }, + ], + }, "labels": { # A group of labels for the file. "hidden": True or False, # Deprecated. "modified": True or False, # Whether the file has been modified by this user. @@ -1380,12 +1532,13 @@

Method Details

- get_media(fileId, acknowledgeAbuse=None, includePermissionsForView=None, projection=None, revisionId=None, supportsAllDrives=None, supportsTeamDrives=None, updateViewedDate=None) + get_media(fileId, acknowledgeAbuse=None, includeLabels=None, includePermissionsForView=None, projection=None, revisionId=None, supportsAllDrives=None, supportsTeamDrives=None, updateViewedDate=None)
Gets a file's metadata or content by ID.
 
 Args:
   fileId: string, The ID for the file in question. (required)
   acknowledgeAbuse: boolean, Whether the user is acknowledging the risk of downloading known malware or other abusive files.
+  includeLabels: string, A comma-separated list of IDs of labels to include in the labelInfo part of the response.
   includePermissionsForView: string, Specifies which additional view's permissions to include in the response. Only 'published' is supported.
   projection: string, This parameter is deprecated and has no function.
     Allowed values
@@ -1403,7 +1556,7 @@ 

Method Details

- insert(body=None, convert=None, enforceSingleParent=None, includePermissionsForView=None, media_body=None, media_mime_type=None, ocr=None, ocrLanguage=None, pinned=None, supportsAllDrives=None, supportsTeamDrives=None, timedTextLanguage=None, timedTextTrackName=None, useContentAsIndexableText=None, visibility=None) + insert(body=None, convert=None, enforceSingleParent=None, includeLabels=None, includePermissionsForView=None, media_body=None, media_mime_type=None, ocr=None, ocrLanguage=None, pinned=None, supportsAllDrives=None, supportsTeamDrives=None, timedTextLanguage=None, timedTextTrackName=None, useContentAsIndexableText=None, visibility=None)
Insert a new file.
 
 Args:
@@ -1432,6 +1585,7 @@ 

Method Details

"canListChildren": True or False, # Whether the current user can list the children of this folder. This is always false when the item is not a folder. "canModifyContent": True or False, # Whether the current user can modify the content of this file. "canModifyContentRestriction": True or False, # Whether the current user can modify restrictions on content of this file. + "canModifyLabels": True or False, # Whether the current user can modify the labels on this file. "canMoveChildrenOutOfDrive": True or False, # Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives. "canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead. "canMoveChildrenWithinDrive": True or False, # Whether the current user can move children of this folder within this drive. This is false when the item is not a folder. Note that a request to move the child may still fail depending on the current user's access to the child and to the destination folder. @@ -1443,6 +1597,7 @@

Method Details

"canMoveItemWithinTeamDrive": True or False, # Deprecated - use canMoveItemWithinDrive instead. "canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead. "canReadDrive": True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives. + "canReadLabels": True or False, # Whether the current user can read the labels on this file. "canReadRevisions": True or False, # Whether the current user can read the revisions resource of this file. For a shared drive item, whether revisions of non-folder descendants of this item, or this item itself if it is not a folder, can be read. "canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead. "canRemoveChildren": True or False, # Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use canDeleteChildren or canTrashChildren instead. @@ -1526,6 +1681,51 @@

Method Details

}, "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app. "kind": "drive#file", # The type of file. This is always drive#file. + "labelInfo": { # An overview of the labels on the file. + "labels": [ # The set of labels on the file as requested by the label IDs in the includeLabels parameter. By default, no labels are returned. + { # Representation of a label and its fields. + "fields": { # A map of the label's fields keyed by the field ID. + "a_key": { # Representation of a label field. + "dateString": [ # Only present if valueType is dateString. RFC 3339 formatted date: YYYY-MM-DD. + "A String", + ], + "id": "A String", # The identifier of this field. + "integer": [ # Only present if valueType is integer. + "A String", + ], + "kind": "drive#labelField", # This is always drive#labelField. + "selection": [ # Only present if valueType is selection. + "A String", + ], + "text": [ # Only present if valueType is text. + "A String", + ], + "user": [ # Only present if valueType is user. + { # Information about a Drive user. + "displayName": "A String", # A plain text displayable name for this user. + "emailAddress": "A String", # The email address of the user. + "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # This is always drive#user. + "permissionId": "A String", # The user's ID as visible in the permissions collection. + "picture": { # The user's profile picture. + "url": "A String", # A URL that points to a profile picture of this user. + }, + }, + ], + "valueType": "A String", # The field type. While new values may be supported in the future, the following are currently allowed: + # - dateString + # - integer + # - selection + # - text + # - user + }, + }, + "id": "A String", # The ID of the label. + "kind": "drive#label", # This is always drive#label + "revisionId": "A String", # The revision ID of the label. + }, + ], + }, "labels": { # A group of labels for the file. "hidden": True or False, # Deprecated. "modified": True or False, # Whether the file has been modified by this user. @@ -1789,6 +1989,7 @@

Method Details

convert: boolean, Whether to convert this file to the corresponding Docs Editors format. enforceSingleParent: boolean, Deprecated. Creating files in multiple folders is no longer supported. + includeLabels: string, A comma-separated list of IDs of labels to include in the labelInfo part of the response. includePermissionsForView: string, Specifies which additional view's permissions to include in the response. Only 'published' is supported. media_body: string, The filename of the media request body, or an instance of a MediaUpload object. media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object. @@ -1830,6 +2031,7 @@

Method Details

"canListChildren": True or False, # Whether the current user can list the children of this folder. This is always false when the item is not a folder. "canModifyContent": True or False, # Whether the current user can modify the content of this file. "canModifyContentRestriction": True or False, # Whether the current user can modify restrictions on content of this file. + "canModifyLabels": True or False, # Whether the current user can modify the labels on this file. "canMoveChildrenOutOfDrive": True or False, # Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives. "canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead. "canMoveChildrenWithinDrive": True or False, # Whether the current user can move children of this folder within this drive. This is false when the item is not a folder. Note that a request to move the child may still fail depending on the current user's access to the child and to the destination folder. @@ -1841,6 +2043,7 @@

Method Details

"canMoveItemWithinTeamDrive": True or False, # Deprecated - use canMoveItemWithinDrive instead. "canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead. "canReadDrive": True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives. + "canReadLabels": True or False, # Whether the current user can read the labels on this file. "canReadRevisions": True or False, # Whether the current user can read the revisions resource of this file. For a shared drive item, whether revisions of non-folder descendants of this item, or this item itself if it is not a folder, can be read. "canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead. "canRemoveChildren": True or False, # Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use canDeleteChildren or canTrashChildren instead. @@ -1924,6 +2127,51 @@

Method Details

}, "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app. "kind": "drive#file", # The type of file. This is always drive#file. + "labelInfo": { # An overview of the labels on the file. + "labels": [ # The set of labels on the file as requested by the label IDs in the includeLabels parameter. By default, no labels are returned. + { # Representation of a label and its fields. + "fields": { # A map of the label's fields keyed by the field ID. + "a_key": { # Representation of a label field. + "dateString": [ # Only present if valueType is dateString. RFC 3339 formatted date: YYYY-MM-DD. + "A String", + ], + "id": "A String", # The identifier of this field. + "integer": [ # Only present if valueType is integer. + "A String", + ], + "kind": "drive#labelField", # This is always drive#labelField. + "selection": [ # Only present if valueType is selection. + "A String", + ], + "text": [ # Only present if valueType is text. + "A String", + ], + "user": [ # Only present if valueType is user. + { # Information about a Drive user. + "displayName": "A String", # A plain text displayable name for this user. + "emailAddress": "A String", # The email address of the user. + "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # This is always drive#user. + "permissionId": "A String", # The user's ID as visible in the permissions collection. + "picture": { # The user's profile picture. + "url": "A String", # A URL that points to a profile picture of this user. + }, + }, + ], + "valueType": "A String", # The field type. While new values may be supported in the future, the following are currently allowed: + # - dateString + # - integer + # - selection + # - text + # - user + }, + }, + "id": "A String", # The ID of the label. + "kind": "drive#label", # This is always drive#label + "revisionId": "A String", # The revision ID of the label. + }, + ], + }, "labels": { # A group of labels for the file. "hidden": True or False, # Deprecated. "modified": True or False, # Whether the file has been modified by this user. @@ -2187,7 +2435,7 @@

Method Details

- list(corpora=None, corpus=None, driveId=None, includeItemsFromAllDrives=None, includePermissionsForView=None, includeTeamDriveItems=None, maxResults=None, orderBy=None, pageToken=None, projection=None, q=None, spaces=None, supportsAllDrives=None, supportsTeamDrives=None, teamDriveId=None) + list(corpora=None, corpus=None, driveId=None, includeItemsFromAllDrives=None, includeLabels=None, includePermissionsForView=None, includeTeamDriveItems=None, maxResults=None, orderBy=None, pageToken=None, projection=None, q=None, spaces=None, supportsAllDrives=None, supportsTeamDrives=None, teamDriveId=None)
Lists the user's files.
 
 Args:
@@ -2198,6 +2446,7 @@ 

Method Details

DOMAIN - Items shared to the user's domain. driveId: string, ID of the shared drive to search. includeItemsFromAllDrives: boolean, Whether both My Drive and shared drive items should be included in results. + includeLabels: string, A comma-separated list of IDs of labels to include in the labelInfo part of the response. includePermissionsForView: string, Specifies which additional view's permissions to include in the response. Only 'published' is supported. includeTeamDriveItems: boolean, Deprecated use includeItemsFromAllDrives instead. maxResults: integer, The maximum number of files to return per page. Partial or empty result pages are possible even before the end of the files list has been reached. @@ -2242,6 +2491,7 @@

Method Details

"canListChildren": True or False, # Whether the current user can list the children of this folder. This is always false when the item is not a folder. "canModifyContent": True or False, # Whether the current user can modify the content of this file. "canModifyContentRestriction": True or False, # Whether the current user can modify restrictions on content of this file. + "canModifyLabels": True or False, # Whether the current user can modify the labels on this file. "canMoveChildrenOutOfDrive": True or False, # Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives. "canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead. "canMoveChildrenWithinDrive": True or False, # Whether the current user can move children of this folder within this drive. This is false when the item is not a folder. Note that a request to move the child may still fail depending on the current user's access to the child and to the destination folder. @@ -2253,6 +2503,7 @@

Method Details

"canMoveItemWithinTeamDrive": True or False, # Deprecated - use canMoveItemWithinDrive instead. "canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead. "canReadDrive": True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives. + "canReadLabels": True or False, # Whether the current user can read the labels on this file. "canReadRevisions": True or False, # Whether the current user can read the revisions resource of this file. For a shared drive item, whether revisions of non-folder descendants of this item, or this item itself if it is not a folder, can be read. "canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead. "canRemoveChildren": True or False, # Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use canDeleteChildren or canTrashChildren instead. @@ -2336,6 +2587,51 @@

Method Details

}, "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app. "kind": "drive#file", # The type of file. This is always drive#file. + "labelInfo": { # An overview of the labels on the file. + "labels": [ # The set of labels on the file as requested by the label IDs in the includeLabels parameter. By default, no labels are returned. + { # Representation of a label and its fields. + "fields": { # A map of the label's fields keyed by the field ID. + "a_key": { # Representation of a label field. + "dateString": [ # Only present if valueType is dateString. RFC 3339 formatted date: YYYY-MM-DD. + "A String", + ], + "id": "A String", # The identifier of this field. + "integer": [ # Only present if valueType is integer. + "A String", + ], + "kind": "drive#labelField", # This is always drive#labelField. + "selection": [ # Only present if valueType is selection. + "A String", + ], + "text": [ # Only present if valueType is text. + "A String", + ], + "user": [ # Only present if valueType is user. + { # Information about a Drive user. + "displayName": "A String", # A plain text displayable name for this user. + "emailAddress": "A String", # The email address of the user. + "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # This is always drive#user. + "permissionId": "A String", # The user's ID as visible in the permissions collection. + "picture": { # The user's profile picture. + "url": "A String", # A URL that points to a profile picture of this user. + }, + }, + ], + "valueType": "A String", # The field type. While new values may be supported in the future, the following are currently allowed: + # - dateString + # - integer + # - selection + # - text + # - user + }, + }, + "id": "A String", # The ID of the label. + "kind": "drive#label", # This is always drive#label + "revisionId": "A String", # The revision ID of the label. + }, + ], + }, "labels": { # A group of labels for the file. "hidden": True or False, # Deprecated. "modified": True or False, # Whether the file has been modified by this user. @@ -2604,6 +2900,81 @@

Method Details

}
+
+ listLabels(fileId, maxResults=None, pageToken=None) +
Lists the labels on a file.
+
+Args:
+  fileId: string, The ID of the file. (required)
+  maxResults: integer, The maximum number of labels to return per page. When not set, this defaults to 100.
+  pageToken: string, The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response.
+
+Returns:
+  An object of the form:
+
+    { # A list of labels.
+  "items": [ # The list of labels.
+    { # Representation of a label and its fields.
+      "fields": { # A map of the label's fields keyed by the field ID.
+        "a_key": { # Representation of a label field.
+          "dateString": [ # Only present if valueType is dateString. RFC 3339 formatted date: YYYY-MM-DD.
+            "A String",
+          ],
+          "id": "A String", # The identifier of this field.
+          "integer": [ # Only present if valueType is integer.
+            "A String",
+          ],
+          "kind": "drive#labelField", # This is always drive#labelField.
+          "selection": [ # Only present if valueType is selection.
+            "A String",
+          ],
+          "text": [ # Only present if valueType is text.
+            "A String",
+          ],
+          "user": [ # Only present if valueType is user.
+            { # Information about a Drive user.
+              "displayName": "A String", # A plain text displayable name for this user.
+              "emailAddress": "A String", # The email address of the user.
+              "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
+              "kind": "drive#user", # This is always drive#user.
+              "permissionId": "A String", # The user's ID as visible in the permissions collection.
+              "picture": { # The user's profile picture.
+                "url": "A String", # A URL that points to a profile picture of this user.
+              },
+            },
+          ],
+          "valueType": "A String", # The field type. While new values may be supported in the future, the following are currently allowed:
+              # - dateString
+              # - integer
+              # - selection
+              # - text
+              # - user
+        },
+      },
+      "id": "A String", # The ID of the label.
+      "kind": "drive#label", # This is always drive#label
+      "revisionId": "A String", # The revision ID of the label.
+    },
+  ],
+  "kind": "drive#labelList", # This is always drive#labelList
+  "nextPageToken": "A String", # The page token for the next page of labels. This field will be absent if the end of the list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results.
+}
+
+ +
+ listLabels_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+
list_next()
Retrieves the next page of results.
@@ -2619,7 +2990,101 @@ 

Method Details

- patch(fileId, addParents=None, body=None, convert=None, enforceSingleParent=None, includePermissionsForView=None, modifiedDateBehavior=None, newRevision=None, ocr=None, ocrLanguage=None, pinned=None, removeParents=None, setModifiedDate=None, supportsAllDrives=None, supportsTeamDrives=None, timedTextLanguage=None, timedTextTrackName=None, updateViewedDate=None, useContentAsIndexableText=None) + modifyLabels(fileId, body=None) +
Modifies the set of labels on a file.
+
+Args:
+  fileId: string, The ID of the file for which the labels are modified. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A request to modify the set of labels on a file. This request may contain many modifications that will either all succeed or all fail transactionally.
+  "kind": "drive#modifyLabelsRequest", # This is always drive#modifyLabelsRequest
+  "labelModifications": [ # The list of modifications to apply to the labels on the file.
+    { # A modification to a label on a file. A LabelModification can be used to apply a label to a file, update an existing label on a file, or remove a label from a file.
+      "fieldModifications": [ # The list of modifications to this label's fields.
+        { # A modification to a label's field.
+          "fieldId": "A String", # The ID of the field to be modified.
+          "kind": "drive#labelFieldModification", # This is always drive#labelFieldModification.
+          "setDateValues": [ # Replaces a dateString field with these new values. The values must be strings in the RFC 3339 full-date format: YYYY-MM-DD.
+            "A String",
+          ],
+          "setIntegerValues": [ # Replaces an integer field with these new values.
+            "A String",
+          ],
+          "setSelectionValues": [ # Replaces a selection field with these new values.
+            "A String",
+          ],
+          "setTextValues": [ # Replaces a text field with these new values.
+            "A String",
+          ],
+          "setUserValues": [ # Replaces a user field with these new values. The values must be valid email addresses.
+            "A String",
+          ],
+          "unsetValues": True or False, # Unsets the values for this field.
+        },
+      ],
+      "kind": "drive#labelModification", # This is always drive#labelModification.
+      "labelId": "A String", # The ID of the label to modify.
+      "removeLabel": True or False, # If true, the label will be removed from the file.
+    },
+  ],
+}
+
+
+Returns:
+  An object of the form:
+
+    { # Response to a ModifyLabels request. This contains only those labels which were added or updated by the request.
+  "kind": "drive#modifyLabelsResponse", # This is always drive#modifyLabelsResponse
+  "modifiedLabels": [ # The list of labels which were added or updated by the request.
+    { # Representation of a label and its fields.
+      "fields": { # A map of the label's fields keyed by the field ID.
+        "a_key": { # Representation of a label field.
+          "dateString": [ # Only present if valueType is dateString. RFC 3339 formatted date: YYYY-MM-DD.
+            "A String",
+          ],
+          "id": "A String", # The identifier of this field.
+          "integer": [ # Only present if valueType is integer.
+            "A String",
+          ],
+          "kind": "drive#labelField", # This is always drive#labelField.
+          "selection": [ # Only present if valueType is selection.
+            "A String",
+          ],
+          "text": [ # Only present if valueType is text.
+            "A String",
+          ],
+          "user": [ # Only present if valueType is user.
+            { # Information about a Drive user.
+              "displayName": "A String", # A plain text displayable name for this user.
+              "emailAddress": "A String", # The email address of the user.
+              "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made.
+              "kind": "drive#user", # This is always drive#user.
+              "permissionId": "A String", # The user's ID as visible in the permissions collection.
+              "picture": { # The user's profile picture.
+                "url": "A String", # A URL that points to a profile picture of this user.
+              },
+            },
+          ],
+          "valueType": "A String", # The field type. While new values may be supported in the future, the following are currently allowed:
+              # - dateString
+              # - integer
+              # - selection
+              # - text
+              # - user
+        },
+      },
+      "id": "A String", # The ID of the label.
+      "kind": "drive#label", # This is always drive#label
+      "revisionId": "A String", # The revision ID of the label.
+    },
+  ],
+}
+
+ +
+ patch(fileId, addParents=None, body=None, convert=None, enforceSingleParent=None, includeLabels=None, includePermissionsForView=None, modifiedDateBehavior=None, newRevision=None, ocr=None, ocrLanguage=None, pinned=None, removeParents=None, setModifiedDate=None, supportsAllDrives=None, supportsTeamDrives=None, timedTextLanguage=None, timedTextTrackName=None, updateViewedDate=None, useContentAsIndexableText=None)
Updates a file's metadata and/or content. When calling this method, only populate fields in the request that you want to modify. When updating fields, some fields might change automatically, such as modifiedDate. This method supports patch semantics.
 
 Args:
@@ -2649,6 +3114,7 @@ 

Method Details

"canListChildren": True or False, # Whether the current user can list the children of this folder. This is always false when the item is not a folder. "canModifyContent": True or False, # Whether the current user can modify the content of this file. "canModifyContentRestriction": True or False, # Whether the current user can modify restrictions on content of this file. + "canModifyLabels": True or False, # Whether the current user can modify the labels on this file. "canMoveChildrenOutOfDrive": True or False, # Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives. "canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead. "canMoveChildrenWithinDrive": True or False, # Whether the current user can move children of this folder within this drive. This is false when the item is not a folder. Note that a request to move the child may still fail depending on the current user's access to the child and to the destination folder. @@ -2660,6 +3126,7 @@

Method Details

"canMoveItemWithinTeamDrive": True or False, # Deprecated - use canMoveItemWithinDrive instead. "canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead. "canReadDrive": True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives. + "canReadLabels": True or False, # Whether the current user can read the labels on this file. "canReadRevisions": True or False, # Whether the current user can read the revisions resource of this file. For a shared drive item, whether revisions of non-folder descendants of this item, or this item itself if it is not a folder, can be read. "canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead. "canRemoveChildren": True or False, # Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use canDeleteChildren or canTrashChildren instead. @@ -2743,6 +3210,51 @@

Method Details

}, "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app. "kind": "drive#file", # The type of file. This is always drive#file. + "labelInfo": { # An overview of the labels on the file. + "labels": [ # The set of labels on the file as requested by the label IDs in the includeLabels parameter. By default, no labels are returned. + { # Representation of a label and its fields. + "fields": { # A map of the label's fields keyed by the field ID. + "a_key": { # Representation of a label field. + "dateString": [ # Only present if valueType is dateString. RFC 3339 formatted date: YYYY-MM-DD. + "A String", + ], + "id": "A String", # The identifier of this field. + "integer": [ # Only present if valueType is integer. + "A String", + ], + "kind": "drive#labelField", # This is always drive#labelField. + "selection": [ # Only present if valueType is selection. + "A String", + ], + "text": [ # Only present if valueType is text. + "A String", + ], + "user": [ # Only present if valueType is user. + { # Information about a Drive user. + "displayName": "A String", # A plain text displayable name for this user. + "emailAddress": "A String", # The email address of the user. + "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # This is always drive#user. + "permissionId": "A String", # The user's ID as visible in the permissions collection. + "picture": { # The user's profile picture. + "url": "A String", # A URL that points to a profile picture of this user. + }, + }, + ], + "valueType": "A String", # The field type. While new values may be supported in the future, the following are currently allowed: + # - dateString + # - integer + # - selection + # - text + # - user + }, + }, + "id": "A String", # The ID of the label. + "kind": "drive#label", # This is always drive#label + "revisionId": "A String", # The revision ID of the label. + }, + ], + }, "labels": { # A group of labels for the file. "hidden": True or False, # Deprecated. "modified": True or False, # Whether the file has been modified by this user. @@ -3007,6 +3519,7 @@

Method Details

addParents: string, Comma-separated list of parent IDs to add. convert: boolean, This parameter is deprecated and has no function. enforceSingleParent: boolean, Deprecated. Adding files to multiple folders is no longer supported. Use shortcuts instead. + includeLabels: string, A comma-separated list of IDs of labels to include in the labelInfo part of the response. includePermissionsForView: string, Specifies which additional view's permissions to include in the response. Only 'published' is supported. modifiedDateBehavior: string, Determines the behavior in which modifiedDate is updated. This overrides setModifiedDate. Allowed values @@ -3054,6 +3567,7 @@

Method Details

"canListChildren": True or False, # Whether the current user can list the children of this folder. This is always false when the item is not a folder. "canModifyContent": True or False, # Whether the current user can modify the content of this file. "canModifyContentRestriction": True or False, # Whether the current user can modify restrictions on content of this file. + "canModifyLabels": True or False, # Whether the current user can modify the labels on this file. "canMoveChildrenOutOfDrive": True or False, # Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives. "canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead. "canMoveChildrenWithinDrive": True or False, # Whether the current user can move children of this folder within this drive. This is false when the item is not a folder. Note that a request to move the child may still fail depending on the current user's access to the child and to the destination folder. @@ -3065,6 +3579,7 @@

Method Details

"canMoveItemWithinTeamDrive": True or False, # Deprecated - use canMoveItemWithinDrive instead. "canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead. "canReadDrive": True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives. + "canReadLabels": True or False, # Whether the current user can read the labels on this file. "canReadRevisions": True or False, # Whether the current user can read the revisions resource of this file. For a shared drive item, whether revisions of non-folder descendants of this item, or this item itself if it is not a folder, can be read. "canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead. "canRemoveChildren": True or False, # Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use canDeleteChildren or canTrashChildren instead. @@ -3148,6 +3663,51 @@

Method Details

}, "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app. "kind": "drive#file", # The type of file. This is always drive#file. + "labelInfo": { # An overview of the labels on the file. + "labels": [ # The set of labels on the file as requested by the label IDs in the includeLabels parameter. By default, no labels are returned. + { # Representation of a label and its fields. + "fields": { # A map of the label's fields keyed by the field ID. + "a_key": { # Representation of a label field. + "dateString": [ # Only present if valueType is dateString. RFC 3339 formatted date: YYYY-MM-DD. + "A String", + ], + "id": "A String", # The identifier of this field. + "integer": [ # Only present if valueType is integer. + "A String", + ], + "kind": "drive#labelField", # This is always drive#labelField. + "selection": [ # Only present if valueType is selection. + "A String", + ], + "text": [ # Only present if valueType is text. + "A String", + ], + "user": [ # Only present if valueType is user. + { # Information about a Drive user. + "displayName": "A String", # A plain text displayable name for this user. + "emailAddress": "A String", # The email address of the user. + "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # This is always drive#user. + "permissionId": "A String", # The user's ID as visible in the permissions collection. + "picture": { # The user's profile picture. + "url": "A String", # A URL that points to a profile picture of this user. + }, + }, + ], + "valueType": "A String", # The field type. While new values may be supported in the future, the following are currently allowed: + # - dateString + # - integer + # - selection + # - text + # - user + }, + }, + "id": "A String", # The ID of the label. + "kind": "drive#label", # This is always drive#label + "revisionId": "A String", # The revision ID of the label. + }, + ], + }, "labels": { # A group of labels for the file. "hidden": True or False, # Deprecated. "modified": True or False, # Whether the file has been modified by this user. @@ -3411,11 +3971,12 @@

Method Details

- touch(fileId, includePermissionsForView=None, supportsAllDrives=None, supportsTeamDrives=None) + touch(fileId, includeLabels=None, includePermissionsForView=None, supportsAllDrives=None, supportsTeamDrives=None)
Set the file's updated time to the current server time.
 
 Args:
   fileId: string, The ID of the file to update. (required)
+  includeLabels: string, A comma-separated list of IDs of labels to include in the labelInfo part of the response.
   includePermissionsForView: string, Specifies which additional view's permissions to include in the response. Only 'published' is supported.
   supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.
   supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.
@@ -3445,6 +4006,7 @@ 

Method Details

"canListChildren": True or False, # Whether the current user can list the children of this folder. This is always false when the item is not a folder. "canModifyContent": True or False, # Whether the current user can modify the content of this file. "canModifyContentRestriction": True or False, # Whether the current user can modify restrictions on content of this file. + "canModifyLabels": True or False, # Whether the current user can modify the labels on this file. "canMoveChildrenOutOfDrive": True or False, # Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives. "canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead. "canMoveChildrenWithinDrive": True or False, # Whether the current user can move children of this folder within this drive. This is false when the item is not a folder. Note that a request to move the child may still fail depending on the current user's access to the child and to the destination folder. @@ -3456,6 +4018,7 @@

Method Details

"canMoveItemWithinTeamDrive": True or False, # Deprecated - use canMoveItemWithinDrive instead. "canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead. "canReadDrive": True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives. + "canReadLabels": True or False, # Whether the current user can read the labels on this file. "canReadRevisions": True or False, # Whether the current user can read the revisions resource of this file. For a shared drive item, whether revisions of non-folder descendants of this item, or this item itself if it is not a folder, can be read. "canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead. "canRemoveChildren": True or False, # Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use canDeleteChildren or canTrashChildren instead. @@ -3539,6 +4102,51 @@

Method Details

}, "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app. "kind": "drive#file", # The type of file. This is always drive#file. + "labelInfo": { # An overview of the labels on the file. + "labels": [ # The set of labels on the file as requested by the label IDs in the includeLabels parameter. By default, no labels are returned. + { # Representation of a label and its fields. + "fields": { # A map of the label's fields keyed by the field ID. + "a_key": { # Representation of a label field. + "dateString": [ # Only present if valueType is dateString. RFC 3339 formatted date: YYYY-MM-DD. + "A String", + ], + "id": "A String", # The identifier of this field. + "integer": [ # Only present if valueType is integer. + "A String", + ], + "kind": "drive#labelField", # This is always drive#labelField. + "selection": [ # Only present if valueType is selection. + "A String", + ], + "text": [ # Only present if valueType is text. + "A String", + ], + "user": [ # Only present if valueType is user. + { # Information about a Drive user. + "displayName": "A String", # A plain text displayable name for this user. + "emailAddress": "A String", # The email address of the user. + "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # This is always drive#user. + "permissionId": "A String", # The user's ID as visible in the permissions collection. + "picture": { # The user's profile picture. + "url": "A String", # A URL that points to a profile picture of this user. + }, + }, + ], + "valueType": "A String", # The field type. While new values may be supported in the future, the following are currently allowed: + # - dateString + # - integer + # - selection + # - text + # - user + }, + }, + "id": "A String", # The ID of the label. + "kind": "drive#label", # This is always drive#label + "revisionId": "A String", # The revision ID of the label. + }, + ], + }, "labels": { # A group of labels for the file. "hidden": True or False, # Deprecated. "modified": True or False, # Whether the file has been modified by this user. @@ -3802,11 +4410,12 @@

Method Details

- trash(fileId, includePermissionsForView=None, supportsAllDrives=None, supportsTeamDrives=None) + trash(fileId, includeLabels=None, includePermissionsForView=None, supportsAllDrives=None, supportsTeamDrives=None)
Moves a file to the trash. The currently authenticated user must own the file or be at least a fileOrganizer on the parent for shared drive files. Only the owner may trash a file. The trashed item is excluded from all files.list responses returned for any user who does not own the file. However, all users with access to the file can see the trashed item metadata in an API response. All users with access can copy, download, export, and share the file.
 
 Args:
   fileId: string, The ID of the file to trash. (required)
+  includeLabels: string, A comma-separated list of IDs of labels to include in the labelInfo part of the response.
   includePermissionsForView: string, Specifies which additional view's permissions to include in the response. Only 'published' is supported.
   supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.
   supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.
@@ -3836,6 +4445,7 @@ 

Method Details

"canListChildren": True or False, # Whether the current user can list the children of this folder. This is always false when the item is not a folder. "canModifyContent": True or False, # Whether the current user can modify the content of this file. "canModifyContentRestriction": True or False, # Whether the current user can modify restrictions on content of this file. + "canModifyLabels": True or False, # Whether the current user can modify the labels on this file. "canMoveChildrenOutOfDrive": True or False, # Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives. "canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead. "canMoveChildrenWithinDrive": True or False, # Whether the current user can move children of this folder within this drive. This is false when the item is not a folder. Note that a request to move the child may still fail depending on the current user's access to the child and to the destination folder. @@ -3847,6 +4457,7 @@

Method Details

"canMoveItemWithinTeamDrive": True or False, # Deprecated - use canMoveItemWithinDrive instead. "canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead. "canReadDrive": True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives. + "canReadLabels": True or False, # Whether the current user can read the labels on this file. "canReadRevisions": True or False, # Whether the current user can read the revisions resource of this file. For a shared drive item, whether revisions of non-folder descendants of this item, or this item itself if it is not a folder, can be read. "canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead. "canRemoveChildren": True or False, # Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use canDeleteChildren or canTrashChildren instead. @@ -3930,6 +4541,51 @@

Method Details

}, "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app. "kind": "drive#file", # The type of file. This is always drive#file. + "labelInfo": { # An overview of the labels on the file. + "labels": [ # The set of labels on the file as requested by the label IDs in the includeLabels parameter. By default, no labels are returned. + { # Representation of a label and its fields. + "fields": { # A map of the label's fields keyed by the field ID. + "a_key": { # Representation of a label field. + "dateString": [ # Only present if valueType is dateString. RFC 3339 formatted date: YYYY-MM-DD. + "A String", + ], + "id": "A String", # The identifier of this field. + "integer": [ # Only present if valueType is integer. + "A String", + ], + "kind": "drive#labelField", # This is always drive#labelField. + "selection": [ # Only present if valueType is selection. + "A String", + ], + "text": [ # Only present if valueType is text. + "A String", + ], + "user": [ # Only present if valueType is user. + { # Information about a Drive user. + "displayName": "A String", # A plain text displayable name for this user. + "emailAddress": "A String", # The email address of the user. + "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # This is always drive#user. + "permissionId": "A String", # The user's ID as visible in the permissions collection. + "picture": { # The user's profile picture. + "url": "A String", # A URL that points to a profile picture of this user. + }, + }, + ], + "valueType": "A String", # The field type. While new values may be supported in the future, the following are currently allowed: + # - dateString + # - integer + # - selection + # - text + # - user + }, + }, + "id": "A String", # The ID of the label. + "kind": "drive#label", # This is always drive#label + "revisionId": "A String", # The revision ID of the label. + }, + ], + }, "labels": { # A group of labels for the file. "hidden": True or False, # Deprecated. "modified": True or False, # Whether the file has been modified by this user. @@ -4193,11 +4849,12 @@

Method Details

- untrash(fileId, includePermissionsForView=None, supportsAllDrives=None, supportsTeamDrives=None) + untrash(fileId, includeLabels=None, includePermissionsForView=None, supportsAllDrives=None, supportsTeamDrives=None)
Restores a file from the trash. The currently authenticated user must own the file or be at least a fileOrganizer on the parent for shared drive files. Only the owner may untrash a file.
 
 Args:
   fileId: string, The ID of the file to untrash. (required)
+  includeLabels: string, A comma-separated list of IDs of labels to include in the labelInfo part of the response.
   includePermissionsForView: string, Specifies which additional view's permissions to include in the response. Only 'published' is supported.
   supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.
   supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.
@@ -4227,6 +4884,7 @@ 

Method Details

"canListChildren": True or False, # Whether the current user can list the children of this folder. This is always false when the item is not a folder. "canModifyContent": True or False, # Whether the current user can modify the content of this file. "canModifyContentRestriction": True or False, # Whether the current user can modify restrictions on content of this file. + "canModifyLabels": True or False, # Whether the current user can modify the labels on this file. "canMoveChildrenOutOfDrive": True or False, # Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives. "canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead. "canMoveChildrenWithinDrive": True or False, # Whether the current user can move children of this folder within this drive. This is false when the item is not a folder. Note that a request to move the child may still fail depending on the current user's access to the child and to the destination folder. @@ -4238,6 +4896,7 @@

Method Details

"canMoveItemWithinTeamDrive": True or False, # Deprecated - use canMoveItemWithinDrive instead. "canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead. "canReadDrive": True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives. + "canReadLabels": True or False, # Whether the current user can read the labels on this file. "canReadRevisions": True or False, # Whether the current user can read the revisions resource of this file. For a shared drive item, whether revisions of non-folder descendants of this item, or this item itself if it is not a folder, can be read. "canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead. "canRemoveChildren": True or False, # Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use canDeleteChildren or canTrashChildren instead. @@ -4321,6 +4980,51 @@

Method Details

}, "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app. "kind": "drive#file", # The type of file. This is always drive#file. + "labelInfo": { # An overview of the labels on the file. + "labels": [ # The set of labels on the file as requested by the label IDs in the includeLabels parameter. By default, no labels are returned. + { # Representation of a label and its fields. + "fields": { # A map of the label's fields keyed by the field ID. + "a_key": { # Representation of a label field. + "dateString": [ # Only present if valueType is dateString. RFC 3339 formatted date: YYYY-MM-DD. + "A String", + ], + "id": "A String", # The identifier of this field. + "integer": [ # Only present if valueType is integer. + "A String", + ], + "kind": "drive#labelField", # This is always drive#labelField. + "selection": [ # Only present if valueType is selection. + "A String", + ], + "text": [ # Only present if valueType is text. + "A String", + ], + "user": [ # Only present if valueType is user. + { # Information about a Drive user. + "displayName": "A String", # A plain text displayable name for this user. + "emailAddress": "A String", # The email address of the user. + "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # This is always drive#user. + "permissionId": "A String", # The user's ID as visible in the permissions collection. + "picture": { # The user's profile picture. + "url": "A String", # A URL that points to a profile picture of this user. + }, + }, + ], + "valueType": "A String", # The field type. While new values may be supported in the future, the following are currently allowed: + # - dateString + # - integer + # - selection + # - text + # - user + }, + }, + "id": "A String", # The ID of the label. + "kind": "drive#label", # This is always drive#label + "revisionId": "A String", # The revision ID of the label. + }, + ], + }, "labels": { # A group of labels for the file. "hidden": True or False, # Deprecated. "modified": True or False, # Whether the file has been modified by this user. @@ -4584,7 +5288,7 @@

Method Details

- update(fileId, addParents=None, body=None, convert=None, enforceSingleParent=None, includePermissionsForView=None, media_body=None, media_mime_type=None, modifiedDateBehavior=None, newRevision=None, ocr=None, ocrLanguage=None, pinned=None, removeParents=None, setModifiedDate=None, supportsAllDrives=None, supportsTeamDrives=None, timedTextLanguage=None, timedTextTrackName=None, updateViewedDate=None, useContentAsIndexableText=None) + update(fileId, addParents=None, body=None, convert=None, enforceSingleParent=None, includeLabels=None, includePermissionsForView=None, media_body=None, media_mime_type=None, modifiedDateBehavior=None, newRevision=None, ocr=None, ocrLanguage=None, pinned=None, removeParents=None, setModifiedDate=None, supportsAllDrives=None, supportsTeamDrives=None, timedTextLanguage=None, timedTextTrackName=None, updateViewedDate=None, useContentAsIndexableText=None)
Updates a file's metadata and/or content. When calling this method, only populate fields in the request that you want to modify. When updating fields, some fields might be changed automatically, such as modifiedDate. This method supports patch semantics.
 
 Args:
@@ -4614,6 +5318,7 @@ 

Method Details

"canListChildren": True or False, # Whether the current user can list the children of this folder. This is always false when the item is not a folder. "canModifyContent": True or False, # Whether the current user can modify the content of this file. "canModifyContentRestriction": True or False, # Whether the current user can modify restrictions on content of this file. + "canModifyLabels": True or False, # Whether the current user can modify the labels on this file. "canMoveChildrenOutOfDrive": True or False, # Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives. "canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead. "canMoveChildrenWithinDrive": True or False, # Whether the current user can move children of this folder within this drive. This is false when the item is not a folder. Note that a request to move the child may still fail depending on the current user's access to the child and to the destination folder. @@ -4625,6 +5330,7 @@

Method Details

"canMoveItemWithinTeamDrive": True or False, # Deprecated - use canMoveItemWithinDrive instead. "canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead. "canReadDrive": True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives. + "canReadLabels": True or False, # Whether the current user can read the labels on this file. "canReadRevisions": True or False, # Whether the current user can read the revisions resource of this file. For a shared drive item, whether revisions of non-folder descendants of this item, or this item itself if it is not a folder, can be read. "canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead. "canRemoveChildren": True or False, # Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use canDeleteChildren or canTrashChildren instead. @@ -4708,6 +5414,51 @@

Method Details

}, "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app. "kind": "drive#file", # The type of file. This is always drive#file. + "labelInfo": { # An overview of the labels on the file. + "labels": [ # The set of labels on the file as requested by the label IDs in the includeLabels parameter. By default, no labels are returned. + { # Representation of a label and its fields. + "fields": { # A map of the label's fields keyed by the field ID. + "a_key": { # Representation of a label field. + "dateString": [ # Only present if valueType is dateString. RFC 3339 formatted date: YYYY-MM-DD. + "A String", + ], + "id": "A String", # The identifier of this field. + "integer": [ # Only present if valueType is integer. + "A String", + ], + "kind": "drive#labelField", # This is always drive#labelField. + "selection": [ # Only present if valueType is selection. + "A String", + ], + "text": [ # Only present if valueType is text. + "A String", + ], + "user": [ # Only present if valueType is user. + { # Information about a Drive user. + "displayName": "A String", # A plain text displayable name for this user. + "emailAddress": "A String", # The email address of the user. + "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # This is always drive#user. + "permissionId": "A String", # The user's ID as visible in the permissions collection. + "picture": { # The user's profile picture. + "url": "A String", # A URL that points to a profile picture of this user. + }, + }, + ], + "valueType": "A String", # The field type. While new values may be supported in the future, the following are currently allowed: + # - dateString + # - integer + # - selection + # - text + # - user + }, + }, + "id": "A String", # The ID of the label. + "kind": "drive#label", # This is always drive#label + "revisionId": "A String", # The revision ID of the label. + }, + ], + }, "labels": { # A group of labels for the file. "hidden": True or False, # Deprecated. "modified": True or False, # Whether the file has been modified by this user. @@ -4972,6 +5723,7 @@

Method Details

addParents: string, Comma-separated list of parent IDs to add. convert: boolean, This parameter is deprecated and has no function. enforceSingleParent: boolean, Deprecated. Adding files to multiple folders is no longer supported. Use shortcuts instead. + includeLabels: string, A comma-separated list of IDs of labels to include in the labelInfo part of the response. includePermissionsForView: string, Specifies which additional view's permissions to include in the response. Only 'published' is supported. media_body: string, The filename of the media request body, or an instance of a MediaUpload object. media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object. @@ -5021,6 +5773,7 @@

Method Details

"canListChildren": True or False, # Whether the current user can list the children of this folder. This is always false when the item is not a folder. "canModifyContent": True or False, # Whether the current user can modify the content of this file. "canModifyContentRestriction": True or False, # Whether the current user can modify restrictions on content of this file. + "canModifyLabels": True or False, # Whether the current user can modify the labels on this file. "canMoveChildrenOutOfDrive": True or False, # Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives. "canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead. "canMoveChildrenWithinDrive": True or False, # Whether the current user can move children of this folder within this drive. This is false when the item is not a folder. Note that a request to move the child may still fail depending on the current user's access to the child and to the destination folder. @@ -5032,6 +5785,7 @@

Method Details

"canMoveItemWithinTeamDrive": True or False, # Deprecated - use canMoveItemWithinDrive instead. "canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead. "canReadDrive": True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives. + "canReadLabels": True or False, # Whether the current user can read the labels on this file. "canReadRevisions": True or False, # Whether the current user can read the revisions resource of this file. For a shared drive item, whether revisions of non-folder descendants of this item, or this item itself if it is not a folder, can be read. "canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead. "canRemoveChildren": True or False, # Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use canDeleteChildren or canTrashChildren instead. @@ -5115,6 +5869,51 @@

Method Details

}, "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app. "kind": "drive#file", # The type of file. This is always drive#file. + "labelInfo": { # An overview of the labels on the file. + "labels": [ # The set of labels on the file as requested by the label IDs in the includeLabels parameter. By default, no labels are returned. + { # Representation of a label and its fields. + "fields": { # A map of the label's fields keyed by the field ID. + "a_key": { # Representation of a label field. + "dateString": [ # Only present if valueType is dateString. RFC 3339 formatted date: YYYY-MM-DD. + "A String", + ], + "id": "A String", # The identifier of this field. + "integer": [ # Only present if valueType is integer. + "A String", + ], + "kind": "drive#labelField", # This is always drive#labelField. + "selection": [ # Only present if valueType is selection. + "A String", + ], + "text": [ # Only present if valueType is text. + "A String", + ], + "user": [ # Only present if valueType is user. + { # Information about a Drive user. + "displayName": "A String", # A plain text displayable name for this user. + "emailAddress": "A String", # The email address of the user. + "isAuthenticatedUser": True or False, # Whether this user is the same as the authenticated user for whom the request was made. + "kind": "drive#user", # This is always drive#user. + "permissionId": "A String", # The user's ID as visible in the permissions collection. + "picture": { # The user's profile picture. + "url": "A String", # A URL that points to a profile picture of this user. + }, + }, + ], + "valueType": "A String", # The field type. While new values may be supported in the future, the following are currently allowed: + # - dateString + # - integer + # - selection + # - text + # - user + }, + }, + "id": "A String", # The ID of the label. + "kind": "drive#label", # This is always drive#label + "revisionId": "A String", # The revision ID of the label. + }, + ], + }, "labels": { # A group of labels for the file. "hidden": True or False, # Deprecated. "modified": True or False, # Whether the file has been modified by this user. @@ -5378,7 +6177,7 @@

Method Details

- watch(fileId, acknowledgeAbuse=None, body=None, includePermissionsForView=None, projection=None, revisionId=None, supportsAllDrives=None, supportsTeamDrives=None, updateViewedDate=None) + watch(fileId, acknowledgeAbuse=None, body=None, includeLabels=None, includePermissionsForView=None, projection=None, revisionId=None, supportsAllDrives=None, supportsTeamDrives=None, updateViewedDate=None)
Subscribes to changes to a file. While you can establish a channel for changes to a file on a shared drive, a change to a shared drive file won't create a notification.
 
 Args:
@@ -5402,6 +6201,7 @@ 

Method Details

} acknowledgeAbuse: boolean, Whether the user is acknowledging the risk of downloading known malware or other abusive files. + includeLabels: string, A comma-separated list of IDs of labels to include in the labelInfo part of the response. includePermissionsForView: string, Specifies which additional view's permissions to include in the response. Only 'published' is supported. projection: string, This parameter is deprecated and has no function. Allowed values @@ -5432,7 +6232,7 @@

Method Details

- watch_media(fileId, acknowledgeAbuse=None, body=None, includePermissionsForView=None, projection=None, revisionId=None, supportsAllDrives=None, supportsTeamDrives=None, updateViewedDate=None) + watch_media(fileId, acknowledgeAbuse=None, body=None, includeLabels=None, includePermissionsForView=None, projection=None, revisionId=None, supportsAllDrives=None, supportsTeamDrives=None, updateViewedDate=None)
Subscribes to changes to a file. While you can establish a channel for changes to a file on a shared drive, a change to a shared drive file won't create a notification.
 
 Args:
@@ -5456,6 +6256,7 @@ 

Method Details

} acknowledgeAbuse: boolean, Whether the user is acknowledging the risk of downloading known malware or other abusive files. + includeLabels: string, A comma-separated list of IDs of labels to include in the labelInfo part of the response. includePermissionsForView: string, Specifies which additional view's permissions to include in the response. Only 'published' is supported. projection: string, This parameter is deprecated and has no function. Allowed values diff --git a/docs/dyn/drive_v3.changes.html b/docs/dyn/drive_v3.changes.html index 6c853f35806..26a0e2cf4d2 100644 --- a/docs/dyn/drive_v3.changes.html +++ b/docs/dyn/drive_v3.changes.html @@ -81,13 +81,13 @@

Instance Methods

getStartPageToken(driveId=None, supportsAllDrives=None, supportsTeamDrives=None, teamDriveId=None)

Gets the starting pageToken for listing future changes.

- list(pageToken, driveId=None, includeCorpusRemovals=None, includeItemsFromAllDrives=None, includePermissionsForView=None, includeRemoved=None, includeTeamDriveItems=None, pageSize=None, restrictToMyDrive=None, spaces=None, supportsAllDrives=None, supportsTeamDrives=None, teamDriveId=None)

+ list(pageToken, driveId=None, includeCorpusRemovals=None, includeItemsFromAllDrives=None, includeLabels=None, includePermissionsForView=None, includeRemoved=None, includeTeamDriveItems=None, pageSize=None, restrictToMyDrive=None, spaces=None, supportsAllDrives=None, supportsTeamDrives=None, teamDriveId=None)

Lists the changes for a user or shared drive.

list_next()

Retrieves the next page of results.

- watch(pageToken, body=None, driveId=None, includeCorpusRemovals=None, includeItemsFromAllDrives=None, includePermissionsForView=None, includeRemoved=None, includeTeamDriveItems=None, pageSize=None, restrictToMyDrive=None, spaces=None, supportsAllDrives=None, supportsTeamDrives=None, teamDriveId=None)

+ watch(pageToken, body=None, driveId=None, includeCorpusRemovals=None, includeItemsFromAllDrives=None, includeLabels=None, includePermissionsForView=None, includeRemoved=None, includeTeamDriveItems=None, pageSize=None, restrictToMyDrive=None, spaces=None, supportsAllDrives=None, supportsTeamDrives=None, teamDriveId=None)

Subscribes to changes for a user.

Method Details

@@ -115,7 +115,7 @@

Method Details

- list(pageToken, driveId=None, includeCorpusRemovals=None, includeItemsFromAllDrives=None, includePermissionsForView=None, includeRemoved=None, includeTeamDriveItems=None, pageSize=None, restrictToMyDrive=None, spaces=None, supportsAllDrives=None, supportsTeamDrives=None, teamDriveId=None) + list(pageToken, driveId=None, includeCorpusRemovals=None, includeItemsFromAllDrives=None, includeLabels=None, includePermissionsForView=None, includeRemoved=None, includeTeamDriveItems=None, pageSize=None, restrictToMyDrive=None, spaces=None, supportsAllDrives=None, supportsTeamDrives=None, teamDriveId=None)
Lists the changes for a user or shared drive.
 
 Args:
@@ -123,6 +123,7 @@ 

Method Details

driveId: string, The shared drive from which changes are returned. If specified the change IDs will be reflective of the shared drive; use the combined drive ID and change ID as an identifier. includeCorpusRemovals: boolean, Whether changes should include the file resource if the file is still accessible by the user at the time of the request, even when a file was removed from the list of changes and there will be no further change entries for this file. includeItemsFromAllDrives: boolean, Whether both My Drive and shared drive items should be included in results. + includeLabels: string, A comma-separated list of IDs of labels to include in the labelInfo part of the response. includePermissionsForView: string, Specifies which additional view's permissions to include in the response. Only 'published' is supported. includeRemoved: boolean, Whether to include changes indicating that items have been removed from the list of changes, for example by deletion or loss of access. includeTeamDriveItems: boolean, Deprecated use includeItemsFromAllDrives instead. @@ -207,6 +208,7 @@

Method Details

"canListChildren": True or False, # Whether the current user can list the children of this folder. This is always false when the item is not a folder. "canModifyContent": True or False, # Whether the current user can modify the content of this file. "canModifyContentRestriction": True or False, # Whether the current user can modify restrictions on content of this file. + "canModifyLabels": True or False, # Whether the current user can modify the labels on this file. "canMoveChildrenOutOfDrive": True or False, # Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives. "canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead. "canMoveChildrenWithinDrive": True or False, # Whether the current user can move children of this folder within this drive. This is false when the item is not a folder. Note that a request to move the child may still fail depending on the current user's access to the child and to the destination folder. @@ -218,6 +220,7 @@

Method Details

"canMoveItemWithinTeamDrive": True or False, # Deprecated - use canMoveItemWithinDrive instead. "canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead. "canReadDrive": True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives. + "canReadLabels": True or False, # Whether the current user can read the labels on this file. "canReadRevisions": True or False, # Whether the current user can read the revisions resource of this file. For a shared drive item, whether revisions of non-folder descendants of this item, or this item itself if it is not a folder, can be read. "canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead. "canRemoveChildren": True or False, # Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use canDeleteChildren or canTrashChildren instead. @@ -298,6 +301,49 @@

Method Details

}, "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app. "kind": "drive#file", # Identifies what kind of resource this is. Value: the fixed string "drive#file". + "labelInfo": { # An overview of the labels on the file. + "labels": [ # The set of labels on the file as requested by the label IDs in the includeLabels parameter. By default, no labels are returned. + { # Representation of a label and its fields. + "fields": { # A map of the label's fields keyed by the field ID. + "a_key": { # Representation of a label field. + "dateString": [ # Only present if valueType is dateString. RFC 3339 formatted date: YYYY-MM-DD. + "A String", + ], + "id": "A String", # The identifier of this field. + "integer": [ # Only present if valueType is integer. + "A String", + ], + "kind": "drive#labelField", # This is always drive#labelField. + "selection": [ # Only present if valueType is selection. + "A String", + ], + "text": [ # Only present if valueType is text. + "A String", + ], + "user": [ # Only present if valueType is user. + { # Information about a Drive user. + "displayName": "A String", # A plain text displayable name for this user. + "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester. + "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user". + "me": True or False, # Whether this user is the requesting user. + "permissionId": "A String", # The user's ID as visible in Permission resources. + "photoLink": "A String", # A link to the user's profile photo, if available. + }, + ], + "valueType": "A String", # The field type. While new values may be supported in the future, the following are currently allowed: + # - dateString + # - integer + # - selection + # - text + # - user + }, + }, + "id": "A String", # The ID of the label. + "kind": "drive#label", # This is always drive#label + "revisionId": "A String", # The revision ID of the label. + }, + ], + }, "lastModifyingUser": { # Information about a Drive user. # The last user to modify the file. "displayName": "A String", # A plain text displayable name for this user. "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester. @@ -520,7 +566,7 @@

Method Details

- watch(pageToken, body=None, driveId=None, includeCorpusRemovals=None, includeItemsFromAllDrives=None, includePermissionsForView=None, includeRemoved=None, includeTeamDriveItems=None, pageSize=None, restrictToMyDrive=None, spaces=None, supportsAllDrives=None, supportsTeamDrives=None, teamDriveId=None) + watch(pageToken, body=None, driveId=None, includeCorpusRemovals=None, includeItemsFromAllDrives=None, includeLabels=None, includePermissionsForView=None, includeRemoved=None, includeTeamDriveItems=None, pageSize=None, restrictToMyDrive=None, spaces=None, supportsAllDrives=None, supportsTeamDrives=None, teamDriveId=None)
Subscribes to changes for a user.
 
 Args:
@@ -546,6 +592,7 @@ 

Method Details

driveId: string, The shared drive from which changes are returned. If specified the change IDs will be reflective of the shared drive; use the combined drive ID and change ID as an identifier. includeCorpusRemovals: boolean, Whether changes should include the file resource if the file is still accessible by the user at the time of the request, even when a file was removed from the list of changes and there will be no further change entries for this file. includeItemsFromAllDrives: boolean, Whether both My Drive and shared drive items should be included in results. + includeLabels: string, A comma-separated list of IDs of labels to include in the labelInfo part of the response. includePermissionsForView: string, Specifies which additional view's permissions to include in the response. Only 'published' is supported. includeRemoved: boolean, Whether to include changes indicating that items have been removed from the list of changes, for example by deletion or loss of access. includeTeamDriveItems: boolean, Deprecated use includeItemsFromAllDrives instead. diff --git a/docs/dyn/drive_v3.files.html b/docs/dyn/drive_v3.files.html index 0f0001fb26d..cafe0af0419 100644 --- a/docs/dyn/drive_v3.files.html +++ b/docs/dyn/drive_v3.files.html @@ -78,10 +78,10 @@

Instance Methods

close()

Close httplib2 connections.

- copy(fileId, body=None, enforceSingleParent=None, ignoreDefaultVisibility=None, includePermissionsForView=None, keepRevisionForever=None, ocrLanguage=None, supportsAllDrives=None, supportsTeamDrives=None)

+ copy(fileId, body=None, enforceSingleParent=None, ignoreDefaultVisibility=None, includeLabels=None, includePermissionsForView=None, keepRevisionForever=None, ocrLanguage=None, supportsAllDrives=None, supportsTeamDrives=None)

Creates a copy of a file and applies any requested updates with patch semantics. Folders cannot be copied.

- create(body=None, enforceSingleParent=None, ignoreDefaultVisibility=None, includePermissionsForView=None, keepRevisionForever=None, media_body=None, media_mime_type=None, ocrLanguage=None, supportsAllDrives=None, supportsTeamDrives=None, useContentAsIndexableText=None)

+ create(body=None, enforceSingleParent=None, ignoreDefaultVisibility=None, includeLabels=None, includePermissionsForView=None, keepRevisionForever=None, media_body=None, media_mime_type=None, ocrLanguage=None, supportsAllDrives=None, supportsTeamDrives=None, useContentAsIndexableText=None)

Creates a new file.

delete(fileId, enforceSingleParent=None, supportsAllDrives=None, supportsTeamDrives=None)

@@ -99,25 +99,34 @@

Instance Methods

generateIds(count=None, space=None, type=None)

Generates a set of file IDs which can be provided in create or copy requests.

- get(fileId, acknowledgeAbuse=None, includePermissionsForView=None, supportsAllDrives=None, supportsTeamDrives=None)

+ get(fileId, acknowledgeAbuse=None, includeLabels=None, includePermissionsForView=None, supportsAllDrives=None, supportsTeamDrives=None)

Gets a file's metadata or content by ID.

- get_media(fileId, acknowledgeAbuse=None, includePermissionsForView=None, supportsAllDrives=None, supportsTeamDrives=None)

+ get_media(fileId, acknowledgeAbuse=None, includeLabels=None, includePermissionsForView=None, supportsAllDrives=None, supportsTeamDrives=None)

Gets a file's metadata or content by ID.

- list(corpora=None, corpus=None, driveId=None, includeItemsFromAllDrives=None, includePermissionsForView=None, includeTeamDriveItems=None, orderBy=None, pageSize=None, pageToken=None, q=None, spaces=None, supportsAllDrives=None, supportsTeamDrives=None, teamDriveId=None)

+ list(corpora=None, corpus=None, driveId=None, includeItemsFromAllDrives=None, includeLabels=None, includePermissionsForView=None, includeTeamDriveItems=None, orderBy=None, pageSize=None, pageToken=None, q=None, spaces=None, supportsAllDrives=None, supportsTeamDrives=None, teamDriveId=None)

Lists or searches files.

+

+ listLabels(fileId, maxResults=None, pageToken=None)

+

Lists the labels on a file.

+

+ listLabels_next()

+

Retrieves the next page of results.

list_next()

Retrieves the next page of results.

- update(fileId, addParents=None, body=None, enforceSingleParent=None, includePermissionsForView=None, keepRevisionForever=None, media_body=None, media_mime_type=None, ocrLanguage=None, removeParents=None, supportsAllDrives=None, supportsTeamDrives=None, useContentAsIndexableText=None)

+ modifyLabels(fileId, body=None)

+

Modifies the set of labels on a file.

+

+ update(fileId, addParents=None, body=None, enforceSingleParent=None, includeLabels=None, includePermissionsForView=None, keepRevisionForever=None, media_body=None, media_mime_type=None, ocrLanguage=None, removeParents=None, supportsAllDrives=None, supportsTeamDrives=None, useContentAsIndexableText=None)

Updates a file's metadata and/or content. When calling this method, only populate fields in the request that you want to modify. When updating fields, some fields might change automatically, such as modifiedDate. This method supports patch semantics.

- watch(fileId, acknowledgeAbuse=None, body=None, includePermissionsForView=None, supportsAllDrives=None, supportsTeamDrives=None)

+ watch(fileId, acknowledgeAbuse=None, body=None, includeLabels=None, includePermissionsForView=None, supportsAllDrives=None, supportsTeamDrives=None)

Subscribes to changes to a file. While you can establish a channel for changes to a file on a shared drive, a change to a shared drive file won't create a notification.

- watch_media(fileId, acknowledgeAbuse=None, body=None, includePermissionsForView=None, supportsAllDrives=None, supportsTeamDrives=None)

+ watch_media(fileId, acknowledgeAbuse=None, body=None, includeLabels=None, includePermissionsForView=None, supportsAllDrives=None, supportsTeamDrives=None)

Subscribes to changes to a file. While you can establish a channel for changes to a file on a shared drive, a change to a shared drive file won't create a notification.

Method Details

@@ -126,7 +135,7 @@

Method Details

- copy(fileId, body=None, enforceSingleParent=None, ignoreDefaultVisibility=None, includePermissionsForView=None, keepRevisionForever=None, ocrLanguage=None, supportsAllDrives=None, supportsTeamDrives=None) + copy(fileId, body=None, enforceSingleParent=None, ignoreDefaultVisibility=None, includeLabels=None, includePermissionsForView=None, keepRevisionForever=None, ocrLanguage=None, supportsAllDrives=None, supportsTeamDrives=None)
Creates a copy of a file and applies any requested updates with patch semantics. Folders cannot be copied.
 
 Args:
@@ -156,6 +165,7 @@ 

Method Details

"canListChildren": True or False, # Whether the current user can list the children of this folder. This is always false when the item is not a folder. "canModifyContent": True or False, # Whether the current user can modify the content of this file. "canModifyContentRestriction": True or False, # Whether the current user can modify restrictions on content of this file. + "canModifyLabels": True or False, # Whether the current user can modify the labels on this file. "canMoveChildrenOutOfDrive": True or False, # Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives. "canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead. "canMoveChildrenWithinDrive": True or False, # Whether the current user can move children of this folder within this drive. This is false when the item is not a folder. Note that a request to move the child may still fail depending on the current user's access to the child and to the destination folder. @@ -167,6 +177,7 @@

Method Details

"canMoveItemWithinTeamDrive": True or False, # Deprecated - use canMoveItemWithinDrive instead. "canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead. "canReadDrive": True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives. + "canReadLabels": True or False, # Whether the current user can read the labels on this file. "canReadRevisions": True or False, # Whether the current user can read the revisions resource of this file. For a shared drive item, whether revisions of non-folder descendants of this item, or this item itself if it is not a folder, can be read. "canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead. "canRemoveChildren": True or False, # Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use canDeleteChildren or canTrashChildren instead. @@ -247,6 +258,49 @@

Method Details

}, "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app. "kind": "drive#file", # Identifies what kind of resource this is. Value: the fixed string "drive#file". + "labelInfo": { # An overview of the labels on the file. + "labels": [ # The set of labels on the file as requested by the label IDs in the includeLabels parameter. By default, no labels are returned. + { # Representation of a label and its fields. + "fields": { # A map of the label's fields keyed by the field ID. + "a_key": { # Representation of a label field. + "dateString": [ # Only present if valueType is dateString. RFC 3339 formatted date: YYYY-MM-DD. + "A String", + ], + "id": "A String", # The identifier of this field. + "integer": [ # Only present if valueType is integer. + "A String", + ], + "kind": "drive#labelField", # This is always drive#labelField. + "selection": [ # Only present if valueType is selection. + "A String", + ], + "text": [ # Only present if valueType is text. + "A String", + ], + "user": [ # Only present if valueType is user. + { # Information about a Drive user. + "displayName": "A String", # A plain text displayable name for this user. + "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester. + "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user". + "me": True or False, # Whether this user is the requesting user. + "permissionId": "A String", # The user's ID as visible in Permission resources. + "photoLink": "A String", # A link to the user's profile photo, if available. + }, + ], + "valueType": "A String", # The field type. While new values may be supported in the future, the following are currently allowed: + # - dateString + # - integer + # - selection + # - text + # - user + }, + }, + "id": "A String", # The ID of the label. + "kind": "drive#label", # This is always drive#label + "revisionId": "A String", # The revision ID of the label. + }, + ], + }, "lastModifyingUser": { # Information about a Drive user. # The last user to modify the file. "displayName": "A String", # A plain text displayable name for this user. "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester. @@ -399,6 +453,7 @@

Method Details

enforceSingleParent: boolean, Deprecated. Copying files into multiple folders is no longer supported. Use shortcuts instead. ignoreDefaultVisibility: boolean, Whether to ignore the domain's default visibility settings for the created file. Domain administrators can choose to make all uploaded files visible to the domain by default; this parameter bypasses that behavior for the request. Permissions are still inherited from parent folders. + includeLabels: string, A comma-separated list of IDs of labels to include in the labelInfo part of the response. includePermissionsForView: string, Specifies which additional view's permissions to include in the response. Only 'published' is supported. keepRevisionForever: boolean, Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions. ocrLanguage: string, A language hint for OCR processing during image import (ISO 639-1 code). @@ -430,6 +485,7 @@

Method Details

"canListChildren": True or False, # Whether the current user can list the children of this folder. This is always false when the item is not a folder. "canModifyContent": True or False, # Whether the current user can modify the content of this file. "canModifyContentRestriction": True or False, # Whether the current user can modify restrictions on content of this file. + "canModifyLabels": True or False, # Whether the current user can modify the labels on this file. "canMoveChildrenOutOfDrive": True or False, # Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives. "canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead. "canMoveChildrenWithinDrive": True or False, # Whether the current user can move children of this folder within this drive. This is false when the item is not a folder. Note that a request to move the child may still fail depending on the current user's access to the child and to the destination folder. @@ -441,6 +497,7 @@

Method Details

"canMoveItemWithinTeamDrive": True or False, # Deprecated - use canMoveItemWithinDrive instead. "canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead. "canReadDrive": True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives. + "canReadLabels": True or False, # Whether the current user can read the labels on this file. "canReadRevisions": True or False, # Whether the current user can read the revisions resource of this file. For a shared drive item, whether revisions of non-folder descendants of this item, or this item itself if it is not a folder, can be read. "canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead. "canRemoveChildren": True or False, # Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use canDeleteChildren or canTrashChildren instead. @@ -521,6 +578,49 @@

Method Details

}, "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app. "kind": "drive#file", # Identifies what kind of resource this is. Value: the fixed string "drive#file". + "labelInfo": { # An overview of the labels on the file. + "labels": [ # The set of labels on the file as requested by the label IDs in the includeLabels parameter. By default, no labels are returned. + { # Representation of a label and its fields. + "fields": { # A map of the label's fields keyed by the field ID. + "a_key": { # Representation of a label field. + "dateString": [ # Only present if valueType is dateString. RFC 3339 formatted date: YYYY-MM-DD. + "A String", + ], + "id": "A String", # The identifier of this field. + "integer": [ # Only present if valueType is integer. + "A String", + ], + "kind": "drive#labelField", # This is always drive#labelField. + "selection": [ # Only present if valueType is selection. + "A String", + ], + "text": [ # Only present if valueType is text. + "A String", + ], + "user": [ # Only present if valueType is user. + { # Information about a Drive user. + "displayName": "A String", # A plain text displayable name for this user. + "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester. + "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user". + "me": True or False, # Whether this user is the requesting user. + "permissionId": "A String", # The user's ID as visible in Permission resources. + "photoLink": "A String", # A link to the user's profile photo, if available. + }, + ], + "valueType": "A String", # The field type. While new values may be supported in the future, the following are currently allowed: + # - dateString + # - integer + # - selection + # - text + # - user + }, + }, + "id": "A String", # The ID of the label. + "kind": "drive#label", # This is always drive#label + "revisionId": "A String", # The revision ID of the label. + }, + ], + }, "lastModifyingUser": { # Information about a Drive user. # The last user to modify the file. "displayName": "A String", # A plain text displayable name for this user. "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester. @@ -673,7 +773,7 @@

Method Details

- create(body=None, enforceSingleParent=None, ignoreDefaultVisibility=None, includePermissionsForView=None, keepRevisionForever=None, media_body=None, media_mime_type=None, ocrLanguage=None, supportsAllDrives=None, supportsTeamDrives=None, useContentAsIndexableText=None) + create(body=None, enforceSingleParent=None, ignoreDefaultVisibility=None, includeLabels=None, includePermissionsForView=None, keepRevisionForever=None, media_body=None, media_mime_type=None, ocrLanguage=None, supportsAllDrives=None, supportsTeamDrives=None, useContentAsIndexableText=None)
Creates a new file.
 
 Args:
@@ -702,6 +802,7 @@ 

Method Details

"canListChildren": True or False, # Whether the current user can list the children of this folder. This is always false when the item is not a folder. "canModifyContent": True or False, # Whether the current user can modify the content of this file. "canModifyContentRestriction": True or False, # Whether the current user can modify restrictions on content of this file. + "canModifyLabels": True or False, # Whether the current user can modify the labels on this file. "canMoveChildrenOutOfDrive": True or False, # Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives. "canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead. "canMoveChildrenWithinDrive": True or False, # Whether the current user can move children of this folder within this drive. This is false when the item is not a folder. Note that a request to move the child may still fail depending on the current user's access to the child and to the destination folder. @@ -713,6 +814,7 @@

Method Details

"canMoveItemWithinTeamDrive": True or False, # Deprecated - use canMoveItemWithinDrive instead. "canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead. "canReadDrive": True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives. + "canReadLabels": True or False, # Whether the current user can read the labels on this file. "canReadRevisions": True or False, # Whether the current user can read the revisions resource of this file. For a shared drive item, whether revisions of non-folder descendants of this item, or this item itself if it is not a folder, can be read. "canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead. "canRemoveChildren": True or False, # Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use canDeleteChildren or canTrashChildren instead. @@ -793,6 +895,49 @@

Method Details

}, "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app. "kind": "drive#file", # Identifies what kind of resource this is. Value: the fixed string "drive#file". + "labelInfo": { # An overview of the labels on the file. + "labels": [ # The set of labels on the file as requested by the label IDs in the includeLabels parameter. By default, no labels are returned. + { # Representation of a label and its fields. + "fields": { # A map of the label's fields keyed by the field ID. + "a_key": { # Representation of a label field. + "dateString": [ # Only present if valueType is dateString. RFC 3339 formatted date: YYYY-MM-DD. + "A String", + ], + "id": "A String", # The identifier of this field. + "integer": [ # Only present if valueType is integer. + "A String", + ], + "kind": "drive#labelField", # This is always drive#labelField. + "selection": [ # Only present if valueType is selection. + "A String", + ], + "text": [ # Only present if valueType is text. + "A String", + ], + "user": [ # Only present if valueType is user. + { # Information about a Drive user. + "displayName": "A String", # A plain text displayable name for this user. + "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester. + "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user". + "me": True or False, # Whether this user is the requesting user. + "permissionId": "A String", # The user's ID as visible in Permission resources. + "photoLink": "A String", # A link to the user's profile photo, if available. + }, + ], + "valueType": "A String", # The field type. While new values may be supported in the future, the following are currently allowed: + # - dateString + # - integer + # - selection + # - text + # - user + }, + }, + "id": "A String", # The ID of the label. + "kind": "drive#label", # This is always drive#label + "revisionId": "A String", # The revision ID of the label. + }, + ], + }, "lastModifyingUser": { # Information about a Drive user. # The last user to modify the file. "displayName": "A String", # A plain text displayable name for this user. "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester. @@ -945,6 +1090,7 @@

Method Details

enforceSingleParent: boolean, Deprecated. Creating files in multiple folders is no longer supported. ignoreDefaultVisibility: boolean, Whether to ignore the domain's default visibility settings for the created file. Domain administrators can choose to make all uploaded files visible to the domain by default; this parameter bypasses that behavior for the request. Permissions are still inherited from parent folders. + includeLabels: string, A comma-separated list of IDs of labels to include in the labelInfo part of the response. includePermissionsForView: string, Specifies which additional view's permissions to include in the response. Only 'published' is supported. keepRevisionForever: boolean, Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions. media_body: string, The filename of the media request body, or an instance of a MediaUpload object. @@ -979,6 +1125,7 @@

Method Details

"canListChildren": True or False, # Whether the current user can list the children of this folder. This is always false when the item is not a folder. "canModifyContent": True or False, # Whether the current user can modify the content of this file. "canModifyContentRestriction": True or False, # Whether the current user can modify restrictions on content of this file. + "canModifyLabels": True or False, # Whether the current user can modify the labels on this file. "canMoveChildrenOutOfDrive": True or False, # Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives. "canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead. "canMoveChildrenWithinDrive": True or False, # Whether the current user can move children of this folder within this drive. This is false when the item is not a folder. Note that a request to move the child may still fail depending on the current user's access to the child and to the destination folder. @@ -990,6 +1137,7 @@

Method Details

"canMoveItemWithinTeamDrive": True or False, # Deprecated - use canMoveItemWithinDrive instead. "canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead. "canReadDrive": True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives. + "canReadLabels": True or False, # Whether the current user can read the labels on this file. "canReadRevisions": True or False, # Whether the current user can read the revisions resource of this file. For a shared drive item, whether revisions of non-folder descendants of this item, or this item itself if it is not a folder, can be read. "canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead. "canRemoveChildren": True or False, # Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use canDeleteChildren or canTrashChildren instead. @@ -1070,6 +1218,49 @@

Method Details

}, "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app. "kind": "drive#file", # Identifies what kind of resource this is. Value: the fixed string "drive#file". + "labelInfo": { # An overview of the labels on the file. + "labels": [ # The set of labels on the file as requested by the label IDs in the includeLabels parameter. By default, no labels are returned. + { # Representation of a label and its fields. + "fields": { # A map of the label's fields keyed by the field ID. + "a_key": { # Representation of a label field. + "dateString": [ # Only present if valueType is dateString. RFC 3339 formatted date: YYYY-MM-DD. + "A String", + ], + "id": "A String", # The identifier of this field. + "integer": [ # Only present if valueType is integer. + "A String", + ], + "kind": "drive#labelField", # This is always drive#labelField. + "selection": [ # Only present if valueType is selection. + "A String", + ], + "text": [ # Only present if valueType is text. + "A String", + ], + "user": [ # Only present if valueType is user. + { # Information about a Drive user. + "displayName": "A String", # A plain text displayable name for this user. + "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester. + "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user". + "me": True or False, # Whether this user is the requesting user. + "permissionId": "A String", # The user's ID as visible in Permission resources. + "photoLink": "A String", # A link to the user's profile photo, if available. + }, + ], + "valueType": "A String", # The field type. While new values may be supported in the future, the following are currently allowed: + # - dateString + # - integer + # - selection + # - text + # - user + }, + }, + "id": "A String", # The ID of the label. + "kind": "drive#label", # This is always drive#label + "revisionId": "A String", # The revision ID of the label. + }, + ], + }, "lastModifyingUser": { # Information about a Drive user. # The last user to modify the file. "displayName": "A String", # A plain text displayable name for this user. "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester. @@ -1284,12 +1475,13 @@

Method Details

- get(fileId, acknowledgeAbuse=None, includePermissionsForView=None, supportsAllDrives=None, supportsTeamDrives=None) + get(fileId, acknowledgeAbuse=None, includeLabels=None, includePermissionsForView=None, supportsAllDrives=None, supportsTeamDrives=None)
Gets a file's metadata or content by ID.
 
 Args:
   fileId: string, The ID of the file. (required)
   acknowledgeAbuse: boolean, Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when alt=media.
+  includeLabels: string, A comma-separated list of IDs of labels to include in the labelInfo part of the response.
   includePermissionsForView: string, Specifies which additional view's permissions to include in the response. Only 'published' is supported.
   supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.
   supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.
@@ -1319,6 +1511,7 @@ 

Method Details

"canListChildren": True or False, # Whether the current user can list the children of this folder. This is always false when the item is not a folder. "canModifyContent": True or False, # Whether the current user can modify the content of this file. "canModifyContentRestriction": True or False, # Whether the current user can modify restrictions on content of this file. + "canModifyLabels": True or False, # Whether the current user can modify the labels on this file. "canMoveChildrenOutOfDrive": True or False, # Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives. "canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead. "canMoveChildrenWithinDrive": True or False, # Whether the current user can move children of this folder within this drive. This is false when the item is not a folder. Note that a request to move the child may still fail depending on the current user's access to the child and to the destination folder. @@ -1330,6 +1523,7 @@

Method Details

"canMoveItemWithinTeamDrive": True or False, # Deprecated - use canMoveItemWithinDrive instead. "canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead. "canReadDrive": True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives. + "canReadLabels": True or False, # Whether the current user can read the labels on this file. "canReadRevisions": True or False, # Whether the current user can read the revisions resource of this file. For a shared drive item, whether revisions of non-folder descendants of this item, or this item itself if it is not a folder, can be read. "canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead. "canRemoveChildren": True or False, # Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use canDeleteChildren or canTrashChildren instead. @@ -1410,6 +1604,49 @@

Method Details

}, "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app. "kind": "drive#file", # Identifies what kind of resource this is. Value: the fixed string "drive#file". + "labelInfo": { # An overview of the labels on the file. + "labels": [ # The set of labels on the file as requested by the label IDs in the includeLabels parameter. By default, no labels are returned. + { # Representation of a label and its fields. + "fields": { # A map of the label's fields keyed by the field ID. + "a_key": { # Representation of a label field. + "dateString": [ # Only present if valueType is dateString. RFC 3339 formatted date: YYYY-MM-DD. + "A String", + ], + "id": "A String", # The identifier of this field. + "integer": [ # Only present if valueType is integer. + "A String", + ], + "kind": "drive#labelField", # This is always drive#labelField. + "selection": [ # Only present if valueType is selection. + "A String", + ], + "text": [ # Only present if valueType is text. + "A String", + ], + "user": [ # Only present if valueType is user. + { # Information about a Drive user. + "displayName": "A String", # A plain text displayable name for this user. + "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester. + "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user". + "me": True or False, # Whether this user is the requesting user. + "permissionId": "A String", # The user's ID as visible in Permission resources. + "photoLink": "A String", # A link to the user's profile photo, if available. + }, + ], + "valueType": "A String", # The field type. While new values may be supported in the future, the following are currently allowed: + # - dateString + # - integer + # - selection + # - text + # - user + }, + }, + "id": "A String", # The ID of the label. + "kind": "drive#label", # This is always drive#label + "revisionId": "A String", # The revision ID of the label. + }, + ], + }, "lastModifyingUser": { # Information about a Drive user. # The last user to modify the file. "displayName": "A String", # A plain text displayable name for this user. "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester. @@ -1562,12 +1799,13 @@

Method Details

- get_media(fileId, acknowledgeAbuse=None, includePermissionsForView=None, supportsAllDrives=None, supportsTeamDrives=None) + get_media(fileId, acknowledgeAbuse=None, includeLabels=None, includePermissionsForView=None, supportsAllDrives=None, supportsTeamDrives=None)
Gets a file's metadata or content by ID.
 
 Args:
   fileId: string, The ID of the file. (required)
   acknowledgeAbuse: boolean, Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when alt=media.
+  includeLabels: string, A comma-separated list of IDs of labels to include in the labelInfo part of the response.
   includePermissionsForView: string, Specifies which additional view's permissions to include in the response. Only 'published' is supported.
   supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives.
   supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.
@@ -1579,7 +1817,7 @@ 

Method Details

- list(corpora=None, corpus=None, driveId=None, includeItemsFromAllDrives=None, includePermissionsForView=None, includeTeamDriveItems=None, orderBy=None, pageSize=None, pageToken=None, q=None, spaces=None, supportsAllDrives=None, supportsTeamDrives=None, teamDriveId=None) + list(corpora=None, corpus=None, driveId=None, includeItemsFromAllDrives=None, includeLabels=None, includePermissionsForView=None, includeTeamDriveItems=None, orderBy=None, pageSize=None, pageToken=None, q=None, spaces=None, supportsAllDrives=None, supportsTeamDrives=None, teamDriveId=None)
Lists or searches files.
 
 Args:
@@ -1590,6 +1828,7 @@ 

Method Details

user - Files owned by or shared to the user. If a user has permissions on a Shared Drive, the files inside it won't be retrieved unless the user has created, opened, or shared the file. driveId: string, ID of the shared drive to search. includeItemsFromAllDrives: boolean, Whether both My Drive and shared drive items should be included in results. + includeLabels: string, A comma-separated list of IDs of labels to include in the labelInfo part of the response. includePermissionsForView: string, Specifies which additional view's permissions to include in the response. Only 'published' is supported. includeTeamDriveItems: boolean, Deprecated use includeItemsFromAllDrives instead. orderBy: string, A comma-separated list of sort keys. Valid keys are 'createdTime', 'folder', 'modifiedByMeTime', 'modifiedTime', 'name', 'name_natural', 'quotaBytesUsed', 'recency', 'sharedWithMeTime', 'starred', and 'viewedByMeTime'. Each key sorts ascending by default, but may be reversed with the 'desc' modifier. Example usage: ?orderBy=folder,modifiedTime desc,name. Please note that there is a current limitation for users with approximately one million files in which the requested sort order is ignored. @@ -1628,6 +1867,7 @@

Method Details

"canListChildren": True or False, # Whether the current user can list the children of this folder. This is always false when the item is not a folder. "canModifyContent": True or False, # Whether the current user can modify the content of this file. "canModifyContentRestriction": True or False, # Whether the current user can modify restrictions on content of this file. + "canModifyLabels": True or False, # Whether the current user can modify the labels on this file. "canMoveChildrenOutOfDrive": True or False, # Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives. "canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead. "canMoveChildrenWithinDrive": True or False, # Whether the current user can move children of this folder within this drive. This is false when the item is not a folder. Note that a request to move the child may still fail depending on the current user's access to the child and to the destination folder. @@ -1639,6 +1879,7 @@

Method Details

"canMoveItemWithinTeamDrive": True or False, # Deprecated - use canMoveItemWithinDrive instead. "canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead. "canReadDrive": True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives. + "canReadLabels": True or False, # Whether the current user can read the labels on this file. "canReadRevisions": True or False, # Whether the current user can read the revisions resource of this file. For a shared drive item, whether revisions of non-folder descendants of this item, or this item itself if it is not a folder, can be read. "canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead. "canRemoveChildren": True or False, # Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use canDeleteChildren or canTrashChildren instead. @@ -1719,6 +1960,49 @@

Method Details

}, "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app. "kind": "drive#file", # Identifies what kind of resource this is. Value: the fixed string "drive#file". + "labelInfo": { # An overview of the labels on the file. + "labels": [ # The set of labels on the file as requested by the label IDs in the includeLabels parameter. By default, no labels are returned. + { # Representation of a label and its fields. + "fields": { # A map of the label's fields keyed by the field ID. + "a_key": { # Representation of a label field. + "dateString": [ # Only present if valueType is dateString. RFC 3339 formatted date: YYYY-MM-DD. + "A String", + ], + "id": "A String", # The identifier of this field. + "integer": [ # Only present if valueType is integer. + "A String", + ], + "kind": "drive#labelField", # This is always drive#labelField. + "selection": [ # Only present if valueType is selection. + "A String", + ], + "text": [ # Only present if valueType is text. + "A String", + ], + "user": [ # Only present if valueType is user. + { # Information about a Drive user. + "displayName": "A String", # A plain text displayable name for this user. + "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester. + "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user". + "me": True or False, # Whether this user is the requesting user. + "permissionId": "A String", # The user's ID as visible in Permission resources. + "photoLink": "A String", # A link to the user's profile photo, if available. + }, + ], + "valueType": "A String", # The field type. While new values may be supported in the future, the following are currently allowed: + # - dateString + # - integer + # - selection + # - text + # - user + }, + }, + "id": "A String", # The ID of the label. + "kind": "drive#label", # This is always drive#label + "revisionId": "A String", # The revision ID of the label. + }, + ], + }, "lastModifyingUser": { # Information about a Drive user. # The last user to modify the file. "displayName": "A String", # A plain text displayable name for this user. "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester. @@ -1875,6 +2159,79 @@

Method Details

}
+
+ listLabels(fileId, maxResults=None, pageToken=None) +
Lists the labels on a file.
+
+Args:
+  fileId: string, The ID of the file. (required)
+  maxResults: integer, The maximum number of labels to return per page. When not set, this defaults to 100.
+  pageToken: string, The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response.
+
+Returns:
+  An object of the form:
+
+    { # A list of labels.
+  "kind": "drive#labelList", # This is always drive#labelList
+  "labels": [ # The list of labels.
+    { # Representation of a label and its fields.
+      "fields": { # A map of the label's fields keyed by the field ID.
+        "a_key": { # Representation of a label field.
+          "dateString": [ # Only present if valueType is dateString. RFC 3339 formatted date: YYYY-MM-DD.
+            "A String",
+          ],
+          "id": "A String", # The identifier of this field.
+          "integer": [ # Only present if valueType is integer.
+            "A String",
+          ],
+          "kind": "drive#labelField", # This is always drive#labelField.
+          "selection": [ # Only present if valueType is selection.
+            "A String",
+          ],
+          "text": [ # Only present if valueType is text.
+            "A String",
+          ],
+          "user": [ # Only present if valueType is user.
+            { # Information about a Drive user.
+              "displayName": "A String", # A plain text displayable name for this user.
+              "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
+              "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
+              "me": True or False, # Whether this user is the requesting user.
+              "permissionId": "A String", # The user's ID as visible in Permission resources.
+              "photoLink": "A String", # A link to the user's profile photo, if available.
+            },
+          ],
+          "valueType": "A String", # The field type. While new values may be supported in the future, the following are currently allowed:
+              # - dateString
+              # - integer
+              # - selection
+              # - text
+              # - user
+        },
+      },
+      "id": "A String", # The ID of the label.
+      "kind": "drive#label", # This is always drive#label
+      "revisionId": "A String", # The revision ID of the label.
+    },
+  ],
+  "nextPageToken": "A String", # The page token for the next page of labels. This field will be absent if the end of the list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results.
+}
+
+ +
+ listLabels_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+
list_next()
Retrieves the next page of results.
@@ -1890,7 +2247,99 @@ 

Method Details

- update(fileId, addParents=None, body=None, enforceSingleParent=None, includePermissionsForView=None, keepRevisionForever=None, media_body=None, media_mime_type=None, ocrLanguage=None, removeParents=None, supportsAllDrives=None, supportsTeamDrives=None, useContentAsIndexableText=None) + modifyLabels(fileId, body=None) +
Modifies the set of labels on a file.
+
+Args:
+  fileId: string, The ID of the file for which the labels are modified. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A request to modify the set of labels on a file. This request may contain many modifications that will either all succeed or all fail transactionally.
+  "kind": "drive#modifyLabelsRequest", # This is always drive#modifyLabelsRequest
+  "labelModifications": [ # The list of modifications to apply to the labels on the file.
+    { # A modification to a label on a file. A LabelModification can be used to apply a label to a file, update an existing label on a file, or remove a label from a file.
+      "fieldModifications": [ # The list of modifications to this label's fields.
+        { # A modification to a label's field.
+          "fieldId": "A String", # The ID of the Field to be modified.
+          "kind": "drive#labelFieldModification", # This is always drive#labelFieldModification.
+          "setDateValues": [ # Replaces a dateString field with these new values. The values must be strings in the RFC 3339 full-date format: YYYY-MM-DD.
+            "A String",
+          ],
+          "setIntegerValues": [ # Replaces an integer field with these new values.
+            "A String",
+          ],
+          "setSelectionValues": [ # Replaces a selection field with these new values.
+            "A String",
+          ],
+          "setTextValues": [ # Replaces a text field with these new values.
+            "A String",
+          ],
+          "setUserValues": [ # Replaces a user field with these new values. The values must be valid email addresses.
+            "A String",
+          ],
+          "unsetValues": True or False, # Unsets the values for this field.
+        },
+      ],
+      "kind": "drive#labelModification", # This is always drive#labelModification.
+      "labelId": "A String", # The ID of the label to modify.
+      "removeLabel": True or False, # If true, the label will be removed from the file.
+    },
+  ],
+}
+
+
+Returns:
+  An object of the form:
+
+    { # Response to a ModifyLabels request. This contains only those labels which were added or updated by the request.
+  "kind": "drive#modifyLabelsResponse", # This is always drive#modifyLabelsResponse
+  "modifiedLabels": [ # The list of labels which were added or updated by the request.
+    { # Representation of a label and its fields.
+      "fields": { # A map of the label's fields keyed by the field ID.
+        "a_key": { # Representation of a label field.
+          "dateString": [ # Only present if valueType is dateString. RFC 3339 formatted date: YYYY-MM-DD.
+            "A String",
+          ],
+          "id": "A String", # The identifier of this field.
+          "integer": [ # Only present if valueType is integer.
+            "A String",
+          ],
+          "kind": "drive#labelField", # This is always drive#labelField.
+          "selection": [ # Only present if valueType is selection.
+            "A String",
+          ],
+          "text": [ # Only present if valueType is text.
+            "A String",
+          ],
+          "user": [ # Only present if valueType is user.
+            { # Information about a Drive user.
+              "displayName": "A String", # A plain text displayable name for this user.
+              "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.
+              "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user".
+              "me": True or False, # Whether this user is the requesting user.
+              "permissionId": "A String", # The user's ID as visible in Permission resources.
+              "photoLink": "A String", # A link to the user's profile photo, if available.
+            },
+          ],
+          "valueType": "A String", # The field type. While new values may be supported in the future, the following are currently allowed:
+              # - dateString
+              # - integer
+              # - selection
+              # - text
+              # - user
+        },
+      },
+      "id": "A String", # The ID of the label.
+      "kind": "drive#label", # This is always drive#label
+      "revisionId": "A String", # The revision ID of the label.
+    },
+  ],
+}
+
+ +
+ update(fileId, addParents=None, body=None, enforceSingleParent=None, includeLabels=None, includePermissionsForView=None, keepRevisionForever=None, media_body=None, media_mime_type=None, ocrLanguage=None, removeParents=None, supportsAllDrives=None, supportsTeamDrives=None, useContentAsIndexableText=None)
Updates a file's metadata and/or content. When calling this method, only populate fields in the request that you want to modify. When updating fields, some fields might change automatically, such as modifiedDate. This method supports patch semantics.
 
 Args:
@@ -1920,6 +2369,7 @@ 

Method Details

"canListChildren": True or False, # Whether the current user can list the children of this folder. This is always false when the item is not a folder. "canModifyContent": True or False, # Whether the current user can modify the content of this file. "canModifyContentRestriction": True or False, # Whether the current user can modify restrictions on content of this file. + "canModifyLabels": True or False, # Whether the current user can modify the labels on this file. "canMoveChildrenOutOfDrive": True or False, # Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives. "canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead. "canMoveChildrenWithinDrive": True or False, # Whether the current user can move children of this folder within this drive. This is false when the item is not a folder. Note that a request to move the child may still fail depending on the current user's access to the child and to the destination folder. @@ -1931,6 +2381,7 @@

Method Details

"canMoveItemWithinTeamDrive": True or False, # Deprecated - use canMoveItemWithinDrive instead. "canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead. "canReadDrive": True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives. + "canReadLabels": True or False, # Whether the current user can read the labels on this file. "canReadRevisions": True or False, # Whether the current user can read the revisions resource of this file. For a shared drive item, whether revisions of non-folder descendants of this item, or this item itself if it is not a folder, can be read. "canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead. "canRemoveChildren": True or False, # Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use canDeleteChildren or canTrashChildren instead. @@ -2011,6 +2462,49 @@

Method Details

}, "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app. "kind": "drive#file", # Identifies what kind of resource this is. Value: the fixed string "drive#file". + "labelInfo": { # An overview of the labels on the file. + "labels": [ # The set of labels on the file as requested by the label IDs in the includeLabels parameter. By default, no labels are returned. + { # Representation of a label and its fields. + "fields": { # A map of the label's fields keyed by the field ID. + "a_key": { # Representation of a label field. + "dateString": [ # Only present if valueType is dateString. RFC 3339 formatted date: YYYY-MM-DD. + "A String", + ], + "id": "A String", # The identifier of this field. + "integer": [ # Only present if valueType is integer. + "A String", + ], + "kind": "drive#labelField", # This is always drive#labelField. + "selection": [ # Only present if valueType is selection. + "A String", + ], + "text": [ # Only present if valueType is text. + "A String", + ], + "user": [ # Only present if valueType is user. + { # Information about a Drive user. + "displayName": "A String", # A plain text displayable name for this user. + "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester. + "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user". + "me": True or False, # Whether this user is the requesting user. + "permissionId": "A String", # The user's ID as visible in Permission resources. + "photoLink": "A String", # A link to the user's profile photo, if available. + }, + ], + "valueType": "A String", # The field type. While new values may be supported in the future, the following are currently allowed: + # - dateString + # - integer + # - selection + # - text + # - user + }, + }, + "id": "A String", # The ID of the label. + "kind": "drive#label", # This is always drive#label + "revisionId": "A String", # The revision ID of the label. + }, + ], + }, "lastModifyingUser": { # Information about a Drive user. # The last user to modify the file. "displayName": "A String", # A plain text displayable name for this user. "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester. @@ -2163,6 +2657,7 @@

Method Details

addParents: string, A comma-separated list of parent IDs to add. enforceSingleParent: boolean, Deprecated. Adding files to multiple folders is no longer supported. Use shortcuts instead. + includeLabels: string, A comma-separated list of IDs of labels to include in the labelInfo part of the response. includePermissionsForView: string, Specifies which additional view's permissions to include in the response. Only 'published' is supported. keepRevisionForever: boolean, Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions. media_body: string, The filename of the media request body, or an instance of a MediaUpload object. @@ -2198,6 +2693,7 @@

Method Details

"canListChildren": True or False, # Whether the current user can list the children of this folder. This is always false when the item is not a folder. "canModifyContent": True or False, # Whether the current user can modify the content of this file. "canModifyContentRestriction": True or False, # Whether the current user can modify restrictions on content of this file. + "canModifyLabels": True or False, # Whether the current user can modify the labels on this file. "canMoveChildrenOutOfDrive": True or False, # Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives. "canMoveChildrenOutOfTeamDrive": True or False, # Deprecated - use canMoveChildrenOutOfDrive instead. "canMoveChildrenWithinDrive": True or False, # Whether the current user can move children of this folder within this drive. This is false when the item is not a folder. Note that a request to move the child may still fail depending on the current user's access to the child and to the destination folder. @@ -2209,6 +2705,7 @@

Method Details

"canMoveItemWithinTeamDrive": True or False, # Deprecated - use canMoveItemWithinDrive instead. "canMoveTeamDriveItem": True or False, # Deprecated - use canMoveItemWithinDrive or canMoveItemOutOfDrive instead. "canReadDrive": True or False, # Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives. + "canReadLabels": True or False, # Whether the current user can read the labels on this file. "canReadRevisions": True or False, # Whether the current user can read the revisions resource of this file. For a shared drive item, whether revisions of non-folder descendants of this item, or this item itself if it is not a folder, can be read. "canReadTeamDrive": True or False, # Deprecated - use canReadDrive instead. "canRemoveChildren": True or False, # Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use canDeleteChildren or canTrashChildren instead. @@ -2289,6 +2786,49 @@

Method Details

}, "isAppAuthorized": True or False, # Whether the file was created or opened by the requesting app. "kind": "drive#file", # Identifies what kind of resource this is. Value: the fixed string "drive#file". + "labelInfo": { # An overview of the labels on the file. + "labels": [ # The set of labels on the file as requested by the label IDs in the includeLabels parameter. By default, no labels are returned. + { # Representation of a label and its fields. + "fields": { # A map of the label's fields keyed by the field ID. + "a_key": { # Representation of a label field. + "dateString": [ # Only present if valueType is dateString. RFC 3339 formatted date: YYYY-MM-DD. + "A String", + ], + "id": "A String", # The identifier of this field. + "integer": [ # Only present if valueType is integer. + "A String", + ], + "kind": "drive#labelField", # This is always drive#labelField. + "selection": [ # Only present if valueType is selection. + "A String", + ], + "text": [ # Only present if valueType is text. + "A String", + ], + "user": [ # Only present if valueType is user. + { # Information about a Drive user. + "displayName": "A String", # A plain text displayable name for this user. + "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester. + "kind": "drive#user", # Identifies what kind of resource this is. Value: the fixed string "drive#user". + "me": True or False, # Whether this user is the requesting user. + "permissionId": "A String", # The user's ID as visible in Permission resources. + "photoLink": "A String", # A link to the user's profile photo, if available. + }, + ], + "valueType": "A String", # The field type. While new values may be supported in the future, the following are currently allowed: + # - dateString + # - integer + # - selection + # - text + # - user + }, + }, + "id": "A String", # The ID of the label. + "kind": "drive#label", # This is always drive#label + "revisionId": "A String", # The revision ID of the label. + }, + ], + }, "lastModifyingUser": { # Information about a Drive user. # The last user to modify the file. "displayName": "A String", # A plain text displayable name for this user. "emailAddress": "A String", # The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester. @@ -2441,7 +2981,7 @@

Method Details

- watch(fileId, acknowledgeAbuse=None, body=None, includePermissionsForView=None, supportsAllDrives=None, supportsTeamDrives=None) + watch(fileId, acknowledgeAbuse=None, body=None, includeLabels=None, includePermissionsForView=None, supportsAllDrives=None, supportsTeamDrives=None)
Subscribes to changes to a file. While you can establish a channel for changes to a file on a shared drive, a change to a shared drive file won't create a notification.
 
 Args:
@@ -2465,6 +3005,7 @@ 

Method Details

} acknowledgeAbuse: boolean, Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when alt=media. + includeLabels: string, A comma-separated list of IDs of labels to include in the labelInfo part of the response. includePermissionsForView: string, Specifies which additional view's permissions to include in the response. Only 'published' is supported. supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives. supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead. @@ -2489,7 +3030,7 @@

Method Details

- watch_media(fileId, acknowledgeAbuse=None, body=None, includePermissionsForView=None, supportsAllDrives=None, supportsTeamDrives=None) + watch_media(fileId, acknowledgeAbuse=None, body=None, includeLabels=None, includePermissionsForView=None, supportsAllDrives=None, supportsTeamDrives=None)
Subscribes to changes to a file. While you can establish a channel for changes to a file on a shared drive, a change to a shared drive file won't create a notification.
 
 Args:
@@ -2513,6 +3054,7 @@ 

Method Details

} acknowledgeAbuse: boolean, Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when alt=media. + includeLabels: string, A comma-separated list of IDs of labels to include in the labelInfo part of the response. includePermissionsForView: string, Specifies which additional view's permissions to include in the response. Only 'published' is supported. supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives. supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead. diff --git a/googleapiclient/discovery_cache/documents/drive.v2.json b/googleapiclient/discovery_cache/documents/drive.v2.json index 89d4fe79d39..062d654f3f2 100644 --- a/googleapiclient/discovery_cache/documents/drive.v2.json +++ b/googleapiclient/discovery_cache/documents/drive.v2.json @@ -38,7 +38,7 @@ "description": "Manages files in Drive including uploading, downloading, searching, detecting changes, and updating sharing permissions.", "discoveryVersion": "v1", "documentationLink": "https://developers.google.com/drive/", - "etag": "\"uWj2hSb4GVjzdDlAnRd2gbM1ZQ8/HE1nDVl6B4Fwkm2egMUaHgUjRYI\"", + "etag": "\"uWj2hSb4GVjzdDlAnRd2gbM1ZQ8/yvf5HwkC5GNTy86jNm4Q9l2g6tw\"", "icons": { "x16": "https://ssl.gstatic.com/docs/doclist/images/drive_icon_16.png", "x32": "https://ssl.gstatic.com/docs/doclist/images/drive_icon_32.png" @@ -327,6 +327,11 @@ "location": "query", "type": "boolean" }, + "includeLabels": { + "description": "A comma-separated list of IDs of labels to include in the labelInfo part of the response.", + "location": "query", + "type": "string" + }, "includePermissionsForView": { "description": "Specifies which additional view's permissions to include in the response. Only 'published' is supported.", "location": "query", @@ -430,6 +435,11 @@ "location": "query", "type": "boolean" }, + "includeLabels": { + "description": "A comma-separated list of IDs of labels to include in the labelInfo part of the response.", + "location": "query", + "type": "string" + }, "includePermissionsForView": { "description": "Specifies which additional view's permissions to include in the response. Only 'published' is supported.", "location": "query", @@ -1160,6 +1170,11 @@ "required": true, "type": "string" }, + "includeLabels": { + "description": "A comma-separated list of IDs of labels to include in the labelInfo part of the response.", + "location": "query", + "type": "string" + }, "includePermissionsForView": { "description": "Specifies which additional view's permissions to include in the response. Only 'published' is supported.", "location": "query", @@ -1378,6 +1393,11 @@ "required": true, "type": "string" }, + "includeLabels": { + "description": "A comma-separated list of IDs of labels to include in the labelInfo part of the response.", + "location": "query", + "type": "string" + }, "includePermissionsForView": { "description": "Specifies which additional view's permissions to include in the response. Only 'published' is supported.", "location": "query", @@ -1470,6 +1490,11 @@ "location": "query", "type": "boolean" }, + "includeLabels": { + "description": "A comma-separated list of IDs of labels to include in the labelInfo part of the response.", + "location": "query", + "type": "string" + }, "includePermissionsForView": { "description": "Specifies which additional view's permissions to include in the response. Only 'published' is supported.", "location": "query", @@ -1585,6 +1610,11 @@ "location": "query", "type": "boolean" }, + "includeLabels": { + "description": "A comma-separated list of IDs of labels to include in the labelInfo part of the response.", + "location": "query", + "type": "string" + }, "includePermissionsForView": { "description": "Specifies which additional view's permissions to include in the response. Only 'published' is supported.", "location": "query", @@ -1670,6 +1700,75 @@ "https://www.googleapis.com/auth/drive.readonly" ] }, + "listLabels": { + "description": "Lists the labels on a file.", + "httpMethod": "GET", + "id": "drive.files.listLabels", + "parameterOrder": [ + "fileId" + ], + "parameters": { + "fileId": { + "description": "The ID of the file.", + "location": "path", + "required": true, + "type": "string" + }, + "maxResults": { + "default": "100", + "description": "The maximum number of labels to return per page. When not set, this defaults to 100.", + "format": "int32", + "location": "query", + "maximum": "100", + "minimum": "1", + "type": "integer" + }, + "pageToken": { + "description": "The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response.", + "location": "query", + "type": "string" + } + }, + "path": "files/{fileId}/listLabels", + "response": { + "$ref": "LabelList" + }, + "scopes": [ + "https://www.googleapis.com/auth/drive", + "https://www.googleapis.com/auth/drive.file", + "https://www.googleapis.com/auth/drive.metadata", + "https://www.googleapis.com/auth/drive.metadata.readonly", + "https://www.googleapis.com/auth/drive.readonly" + ] + }, + "modifyLabels": { + "description": "Modifies the set of labels on a file.", + "httpMethod": "POST", + "id": "drive.files.modifyLabels", + "parameterOrder": [ + "fileId" + ], + "parameters": { + "fileId": { + "description": "The ID of the file for which the labels are modified.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "files/{fileId}/modifyLabels", + "request": { + "$ref": "ModifyLabelsRequest" + }, + "response": { + "$ref": "ModifyLabelsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/drive", + "https://www.googleapis.com/auth/drive.file", + "https://www.googleapis.com/auth/drive.metadata" + ] + }, "patch": { "description": "Updates a file's metadata and/or content. When calling this method, only populate fields in the request that you want to modify. When updating fields, some fields might change automatically, such as modifiedDate. This method supports patch semantics.", "httpMethod": "PATCH", @@ -1701,6 +1800,11 @@ "required": true, "type": "string" }, + "includeLabels": { + "description": "A comma-separated list of IDs of labels to include in the labelInfo part of the response.", + "location": "query", + "type": "string" + }, "includePermissionsForView": { "description": "Specifies which additional view's permissions to include in the response. Only 'published' is supported.", "location": "query", @@ -1826,6 +1930,11 @@ "required": true, "type": "string" }, + "includeLabels": { + "description": "A comma-separated list of IDs of labels to include in the labelInfo part of the response.", + "location": "query", + "type": "string" + }, "includePermissionsForView": { "description": "Specifies which additional view's permissions to include in the response. Only 'published' is supported.", "location": "query", @@ -1870,6 +1979,11 @@ "required": true, "type": "string" }, + "includeLabels": { + "description": "A comma-separated list of IDs of labels to include in the labelInfo part of the response.", + "location": "query", + "type": "string" + }, "includePermissionsForView": { "description": "Specifies which additional view's permissions to include in the response. Only 'published' is supported.", "location": "query", @@ -1913,6 +2027,11 @@ "required": true, "type": "string" }, + "includeLabels": { + "description": "A comma-separated list of IDs of labels to include in the labelInfo part of the response.", + "location": "query", + "type": "string" + }, "includePermissionsForView": { "description": "Specifies which additional view's permissions to include in the response. Only 'published' is supported.", "location": "query", @@ -1989,6 +2108,11 @@ "required": true, "type": "string" }, + "includeLabels": { + "description": "A comma-separated list of IDs of labels to include in the labelInfo part of the response.", + "location": "query", + "type": "string" + }, "includePermissionsForView": { "description": "Specifies which additional view's permissions to include in the response. Only 'published' is supported.", "location": "query", @@ -2121,6 +2245,11 @@ "required": true, "type": "string" }, + "includeLabels": { + "description": "A comma-separated list of IDs of labels to include in the labelInfo part of the response.", + "location": "query", + "type": "string" + }, "includePermissionsForView": { "description": "Specifies which additional view's permissions to include in the response. Only 'published' is supported.", "location": "query", @@ -3539,7 +3668,7 @@ } } }, - "revision": "20220626", + "revision": "20220709", "rootUrl": "https://www.googleapis.com/", "schemas": { "About": { @@ -4720,6 +4849,10 @@ "description": "Whether the current user can modify restrictions on content of this file.", "type": "boolean" }, + "canModifyLabels": { + "description": "Whether the current user can modify the labels on this file.", + "type": "boolean" + }, "canMoveChildrenOutOfDrive": { "description": "Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives.", "type": "boolean" @@ -4764,6 +4897,10 @@ "description": "Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives.", "type": "boolean" }, + "canReadLabels": { + "description": "Whether the current user can read the labels on this file.", + "type": "boolean" + }, "canReadRevisions": { "description": "Whether the current user can read the revisions resource of this file. For a shared drive item, whether revisions of non-folder descendants of this item, or this item itself if it is not a folder, can be read.", "type": "boolean" @@ -5037,6 +5174,19 @@ "description": "The type of file. This is always drive#file.", "type": "string" }, + "labelInfo": { + "description": "An overview of the labels on the file.", + "properties": { + "labels": { + "description": "The set of labels on the file as requested by the label IDs in the includeLabels parameter. By default, no labels are returned.", + "items": { + "$ref": "Label" + }, + "type": "array" + } + }, + "type": "object" + }, "labels": { "description": "A group of labels for the file.", "properties": { @@ -5377,6 +5527,240 @@ }, "type": "object" }, + "Label": { + "description": "Representation of a label and its fields.", + "id": "Label", + "properties": { + "fields": { + "additionalProperties": { + "$ref": "LabelField" + }, + "description": "A map of the label's fields keyed by the field ID.", + "type": "object" + }, + "id": { + "description": "The ID of the label.", + "type": "string" + }, + "kind": { + "default": "drive#label", + "description": "This is always drive#label", + "type": "string" + }, + "revisionId": { + "description": "The revision ID of the label.", + "type": "string" + } + }, + "type": "object" + }, + "LabelField": { + "description": "Representation of a label field.", + "id": "LabelField", + "properties": { + "dateString": { + "description": "Only present if valueType is dateString. RFC 3339 formatted date: YYYY-MM-DD.", + "items": { + "format": "date", + "type": "string" + }, + "type": "array" + }, + "id": { + "description": "The identifier of this field.", + "type": "string" + }, + "integer": { + "description": "Only present if valueType is integer.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + }, + "kind": { + "default": "drive#labelField", + "description": "This is always drive#labelField.", + "type": "string" + }, + "selection": { + "description": "Only present if valueType is selection.", + "items": { + "type": "string" + }, + "type": "array" + }, + "text": { + "description": "Only present if valueType is text.", + "items": { + "type": "string" + }, + "type": "array" + }, + "user": { + "description": "Only present if valueType is user.", + "items": { + "$ref": "User" + }, + "type": "array" + }, + "valueType": { + "description": "The field type. While new values may be supported in the future, the following are currently allowed: \n- dateString \n- integer \n- selection \n- text \n- user", + "type": "string" + } + }, + "type": "object" + }, + "LabelFieldModification": { + "description": "A modification to a label's field.", + "id": "LabelFieldModification", + "properties": { + "fieldId": { + "description": "The ID of the field to be modified.", + "type": "string" + }, + "kind": { + "default": "drive#labelFieldModification", + "description": "This is always drive#labelFieldModification.", + "type": "string" + }, + "setDateValues": { + "description": "Replaces a dateString field with these new values. The values must be strings in the RFC 3339 full-date format: YYYY-MM-DD.", + "items": { + "format": "date", + "type": "string" + }, + "type": "array" + }, + "setIntegerValues": { + "description": "Replaces an integer field with these new values.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + }, + "setSelectionValues": { + "description": "Replaces a selection field with these new values.", + "items": { + "type": "string" + }, + "type": "array" + }, + "setTextValues": { + "description": "Replaces a text field with these new values.", + "items": { + "type": "string" + }, + "type": "array" + }, + "setUserValues": { + "description": "Replaces a user field with these new values. The values must be valid email addresses.", + "items": { + "type": "string" + }, + "type": "array" + }, + "unsetValues": { + "description": "Unsets the values for this field.", + "type": "boolean" + } + }, + "type": "object" + }, + "LabelList": { + "description": "A list of labels.", + "id": "LabelList", + "properties": { + "items": { + "description": "The list of labels.", + "items": { + "$ref": "Label" + }, + "type": "array" + }, + "kind": { + "default": "drive#labelList", + "description": "This is always drive#labelList", + "type": "string" + }, + "nextPageToken": { + "description": "The page token for the next page of labels. This field will be absent if the end of the list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results.", + "type": "string" + } + }, + "type": "object" + }, + "LabelModification": { + "description": "A modification to a label on a file. A LabelModification can be used to apply a label to a file, update an existing label on a file, or remove a label from a file.", + "id": "LabelModification", + "properties": { + "fieldModifications": { + "description": "The list of modifications to this label's fields.", + "items": { + "$ref": "LabelFieldModification" + }, + "type": "array" + }, + "kind": { + "default": "drive#labelModification", + "description": "This is always drive#labelModification.", + "type": "string" + }, + "labelId": { + "annotations": { + "required": [ + "drive.files.modifyLabels" + ] + }, + "description": "The ID of the label to modify.", + "type": "string" + }, + "removeLabel": { + "description": "If true, the label will be removed from the file.", + "type": "boolean" + } + }, + "type": "object" + }, + "ModifyLabelsRequest": { + "description": "A request to modify the set of labels on a file. This request may contain many modifications that will either all succeed or all fail transactionally.", + "id": "ModifyLabelsRequest", + "properties": { + "kind": { + "default": "drive#modifyLabelsRequest", + "description": "This is always drive#modifyLabelsRequest", + "type": "string" + }, + "labelModifications": { + "description": "The list of modifications to apply to the labels on the file.", + "items": { + "$ref": "LabelModification" + }, + "type": "array" + } + }, + "type": "object" + }, + "ModifyLabelsResponse": { + "description": "Response to a ModifyLabels request. This contains only those labels which were added or updated by the request.", + "id": "ModifyLabelsResponse", + "properties": { + "kind": { + "default": "drive#modifyLabelsResponse", + "description": "This is always drive#modifyLabelsResponse", + "type": "string" + }, + "modifiedLabels": { + "description": "The list of labels which were added or updated by the request.", + "items": { + "$ref": "Label" + }, + "type": "array" + } + }, + "type": "object" + }, "ParentList": { "description": "A list of a file's parents.", "id": "ParentList", diff --git a/googleapiclient/discovery_cache/documents/drive.v3.json b/googleapiclient/discovery_cache/documents/drive.v3.json index 13c91c4d6e6..55999ba85f5 100644 --- a/googleapiclient/discovery_cache/documents/drive.v3.json +++ b/googleapiclient/discovery_cache/documents/drive.v3.json @@ -35,7 +35,7 @@ "description": "Manages files in Drive including uploading, downloading, searching, detecting changes, and updating sharing permissions.", "discoveryVersion": "v1", "documentationLink": "https://developers.google.com/drive/", - "etag": "\"uWj2hSb4GVjzdDlAnRd2gbM1ZQ8/ZoIGFthYYhyMpn91xaHVprqwgu4\"", + "etag": "\"uWj2hSb4GVjzdDlAnRd2gbM1ZQ8/w7NrSVvAsjGozhSi_2XXg55ifjM\"", "icons": { "x16": "https://ssl.gstatic.com/docs/doclist/images/drive_icon_16.png", "x32": "https://ssl.gstatic.com/docs/doclist/images/drive_icon_32.png" @@ -183,6 +183,11 @@ "location": "query", "type": "boolean" }, + "includeLabels": { + "description": "A comma-separated list of IDs of labels to include in the labelInfo part of the response.", + "location": "query", + "type": "string" + }, "includePermissionsForView": { "description": "Specifies which additional view's permissions to include in the response. Only 'published' is supported.", "location": "query", @@ -285,6 +290,11 @@ "location": "query", "type": "boolean" }, + "includeLabels": { + "description": "A comma-separated list of IDs of labels to include in the labelInfo part of the response.", + "location": "query", + "type": "string" + }, "includePermissionsForView": { "description": "Specifies which additional view's permissions to include in the response. Only 'published' is supported.", "location": "query", @@ -810,6 +820,11 @@ "location": "query", "type": "boolean" }, + "includeLabels": { + "description": "A comma-separated list of IDs of labels to include in the labelInfo part of the response.", + "location": "query", + "type": "string" + }, "includePermissionsForView": { "description": "Specifies which additional view's permissions to include in the response. Only 'published' is supported.", "location": "query", @@ -886,6 +901,11 @@ "location": "query", "type": "boolean" }, + "includeLabels": { + "description": "A comma-separated list of IDs of labels to include in the labelInfo part of the response.", + "location": "query", + "type": "string" + }, "includePermissionsForView": { "description": "Specifies which additional view's permissions to include in the response. Only 'published' is supported.", "location": "query", @@ -1080,6 +1100,11 @@ "required": true, "type": "string" }, + "includeLabels": { + "description": "A comma-separated list of IDs of labels to include in the labelInfo part of the response.", + "location": "query", + "type": "string" + }, "includePermissionsForView": { "description": "Specifies which additional view's permissions to include in the response. Only 'published' is supported.", "location": "query", @@ -1149,6 +1174,11 @@ "location": "query", "type": "boolean" }, + "includeLabels": { + "description": "A comma-separated list of IDs of labels to include in the labelInfo part of the response.", + "location": "query", + "type": "string" + }, "includePermissionsForView": { "description": "Specifies which additional view's permissions to include in the response. Only 'published' is supported.", "location": "query", @@ -1222,6 +1252,75 @@ "https://www.googleapis.com/auth/drive.readonly" ] }, + "listLabels": { + "description": "Lists the labels on a file.", + "httpMethod": "GET", + "id": "drive.files.listLabels", + "parameterOrder": [ + "fileId" + ], + "parameters": { + "fileId": { + "description": "The ID of the file.", + "location": "path", + "required": true, + "type": "string" + }, + "maxResults": { + "default": "100", + "description": "The maximum number of labels to return per page. When not set, this defaults to 100.", + "format": "int32", + "location": "query", + "maximum": "100", + "minimum": "1", + "type": "integer" + }, + "pageToken": { + "description": "The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response.", + "location": "query", + "type": "string" + } + }, + "path": "files/{fileId}/listLabels", + "response": { + "$ref": "LabelList" + }, + "scopes": [ + "https://www.googleapis.com/auth/drive", + "https://www.googleapis.com/auth/drive.file", + "https://www.googleapis.com/auth/drive.metadata", + "https://www.googleapis.com/auth/drive.metadata.readonly", + "https://www.googleapis.com/auth/drive.readonly" + ] + }, + "modifyLabels": { + "description": "Modifies the set of labels on a file.", + "httpMethod": "POST", + "id": "drive.files.modifyLabels", + "parameterOrder": [ + "fileId" + ], + "parameters": { + "fileId": { + "description": "The ID of the file for which the labels are modified.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "files/{fileId}/modifyLabels", + "request": { + "$ref": "ModifyLabelsRequest" + }, + "response": { + "$ref": "ModifyLabelsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/drive", + "https://www.googleapis.com/auth/drive.file", + "https://www.googleapis.com/auth/drive.metadata" + ] + }, "update": { "description": "Updates a file's metadata and/or content. When calling this method, only populate fields in the request that you want to modify. When updating fields, some fields might change automatically, such as modifiedDate. This method supports patch semantics.", "httpMethod": "PATCH", @@ -1263,6 +1362,11 @@ "required": true, "type": "string" }, + "includeLabels": { + "description": "A comma-separated list of IDs of labels to include in the labelInfo part of the response.", + "location": "query", + "type": "string" + }, "includePermissionsForView": { "description": "Specifies which additional view's permissions to include in the response. Only 'published' is supported.", "location": "query", @@ -1339,6 +1443,11 @@ "required": true, "type": "string" }, + "includeLabels": { + "description": "A comma-separated list of IDs of labels to include in the labelInfo part of the response.", + "location": "query", + "type": "string" + }, "includePermissionsForView": { "description": "Specifies which additional view's permissions to include in the response. Only 'published' is supported.", "location": "query", @@ -2203,7 +2312,7 @@ } } }, - "revision": "20220626", + "revision": "20220709", "rootUrl": "https://www.googleapis.com/", "schemas": { "About": { @@ -2883,6 +2992,10 @@ "description": "Whether the current user can modify restrictions on content of this file.", "type": "boolean" }, + "canModifyLabels": { + "description": "Whether the current user can modify the labels on this file.", + "type": "boolean" + }, "canMoveChildrenOutOfDrive": { "description": "Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives.", "type": "boolean" @@ -2927,6 +3040,10 @@ "description": "Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives.", "type": "boolean" }, + "canReadLabels": { + "description": "Whether the current user can read the labels on this file.", + "type": "boolean" + }, "canReadRevisions": { "description": "Whether the current user can read the revisions resource of this file. For a shared drive item, whether revisions of non-folder descendants of this item, or this item itself if it is not a folder, can be read.", "type": "boolean" @@ -3186,6 +3303,19 @@ "description": "Identifies what kind of resource this is. Value: the fixed string \"drive#file\".", "type": "string" }, + "labelInfo": { + "description": "An overview of the labels on the file.", + "properties": { + "labels": { + "description": "The set of labels on the file as requested by the label IDs in the includeLabels parameter. By default, no labels are returned.", + "items": { + "$ref": "Label" + }, + "type": "array" + } + }, + "type": "object" + }, "lastModifyingUser": { "$ref": "User", "description": "The last user to modify the file." @@ -3459,6 +3589,240 @@ }, "type": "object" }, + "Label": { + "description": "Representation of a label and its fields.", + "id": "Label", + "properties": { + "fields": { + "additionalProperties": { + "$ref": "LabelField" + }, + "description": "A map of the label's fields keyed by the field ID.", + "type": "object" + }, + "id": { + "description": "The ID of the label.", + "type": "string" + }, + "kind": { + "default": "drive#label", + "description": "This is always drive#label", + "type": "string" + }, + "revisionId": { + "description": "The revision ID of the label.", + "type": "string" + } + }, + "type": "object" + }, + "LabelField": { + "description": "Representation of a label field.", + "id": "LabelField", + "properties": { + "dateString": { + "description": "Only present if valueType is dateString. RFC 3339 formatted date: YYYY-MM-DD.", + "items": { + "format": "date", + "type": "string" + }, + "type": "array" + }, + "id": { + "description": "The identifier of this field.", + "type": "string" + }, + "integer": { + "description": "Only present if valueType is integer.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + }, + "kind": { + "default": "drive#labelField", + "description": "This is always drive#labelField.", + "type": "string" + }, + "selection": { + "description": "Only present if valueType is selection.", + "items": { + "type": "string" + }, + "type": "array" + }, + "text": { + "description": "Only present if valueType is text.", + "items": { + "type": "string" + }, + "type": "array" + }, + "user": { + "description": "Only present if valueType is user.", + "items": { + "$ref": "User" + }, + "type": "array" + }, + "valueType": { + "description": "The field type. While new values may be supported in the future, the following are currently allowed: \n- dateString \n- integer \n- selection \n- text \n- user", + "type": "string" + } + }, + "type": "object" + }, + "LabelFieldModification": { + "description": "A modification to a label's field.", + "id": "LabelFieldModification", + "properties": { + "fieldId": { + "description": "The ID of the Field to be modified.", + "type": "string" + }, + "kind": { + "default": "drive#labelFieldModification", + "description": "This is always drive#labelFieldModification.", + "type": "string" + }, + "setDateValues": { + "description": "Replaces a dateString field with these new values. The values must be strings in the RFC 3339 full-date format: YYYY-MM-DD.", + "items": { + "format": "date", + "type": "string" + }, + "type": "array" + }, + "setIntegerValues": { + "description": "Replaces an integer field with these new values.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + }, + "setSelectionValues": { + "description": "Replaces a selection field with these new values.", + "items": { + "type": "string" + }, + "type": "array" + }, + "setTextValues": { + "description": "Replaces a text field with these new values.", + "items": { + "type": "string" + }, + "type": "array" + }, + "setUserValues": { + "description": "Replaces a user field with these new values. The values must be valid email addresses.", + "items": { + "type": "string" + }, + "type": "array" + }, + "unsetValues": { + "description": "Unsets the values for this field.", + "type": "boolean" + } + }, + "type": "object" + }, + "LabelList": { + "description": "A list of labels.", + "id": "LabelList", + "properties": { + "kind": { + "default": "drive#labelList", + "description": "This is always drive#labelList", + "type": "string" + }, + "labels": { + "description": "The list of labels.", + "items": { + "$ref": "Label" + }, + "type": "array" + }, + "nextPageToken": { + "description": "The page token for the next page of labels. This field will be absent if the end of the list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results.", + "type": "string" + } + }, + "type": "object" + }, + "LabelModification": { + "description": "A modification to a label on a file. A LabelModification can be used to apply a label to a file, update an existing label on a file, or remove a label from a file.", + "id": "LabelModification", + "properties": { + "fieldModifications": { + "description": "The list of modifications to this label's fields.", + "items": { + "$ref": "LabelFieldModification" + }, + "type": "array" + }, + "kind": { + "default": "drive#labelModification", + "description": "This is always drive#labelModification.", + "type": "string" + }, + "labelId": { + "annotations": { + "required": [ + "drive.files.modifyLabels" + ] + }, + "description": "The ID of the label to modify.", + "type": "string" + }, + "removeLabel": { + "description": "If true, the label will be removed from the file.", + "type": "boolean" + } + }, + "type": "object" + }, + "ModifyLabelsRequest": { + "description": "A request to modify the set of labels on a file. This request may contain many modifications that will either all succeed or all fail transactionally.", + "id": "ModifyLabelsRequest", + "properties": { + "kind": { + "default": "drive#modifyLabelsRequest", + "description": "This is always drive#modifyLabelsRequest", + "type": "string" + }, + "labelModifications": { + "description": "The list of modifications to apply to the labels on the file.", + "items": { + "$ref": "LabelModification" + }, + "type": "array" + } + }, + "type": "object" + }, + "ModifyLabelsResponse": { + "description": "Response to a ModifyLabels request. This contains only those labels which were added or updated by the request.", + "id": "ModifyLabelsResponse", + "properties": { + "kind": { + "default": "drive#modifyLabelsResponse", + "description": "This is always drive#modifyLabelsResponse", + "type": "string" + }, + "modifiedLabels": { + "description": "The list of labels which were added or updated by the request.", + "items": { + "$ref": "Label" + }, + "type": "array" + } + }, + "type": "object" + }, "Permission": { "description": "A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.", "id": "Permission", From 7fdfb91f6723dea05af302b5b8ac089d2be5f808 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 19 Jul 2022 07:08:14 +0000 Subject: [PATCH 16/23] feat(gkehub): update the api #### gkehub:v1alpha The following keys were added: - schemas.IdentityServiceAuthMethod.properties.azureadConfig.$ref (Total Keys: 1) - schemas.IdentityServiceAzureADConfig (Total Keys: 8) #### gkehub:v1beta The following keys were added: - schemas.PolicyControllerHubConfig.properties.mutationEnabled.type (Total Keys: 1) --- ...b_v1alpha.projects.locations.features.html | 56 +++++++++++++++++++ ...ub_v1beta.projects.locations.features.html | 8 +++ .../discovery_cache/documents/gkehub.v1.json | 2 +- .../documents/gkehub.v1alpha.json | 34 ++++++++++- .../documents/gkehub.v1alpha2.json | 2 +- .../documents/gkehub.v1beta.json | 6 +- .../documents/gkehub.v1beta1.json | 2 +- .../documents/gkehub.v2alpha.json | 2 +- 8 files changed, 106 insertions(+), 6 deletions(-) diff --git a/docs/dyn/gkehub_v1alpha.projects.locations.features.html b/docs/dyn/gkehub_v1alpha.projects.locations.features.html index ab60cadf061..98aa18d5e01 100644 --- a/docs/dyn/gkehub_v1alpha.projects.locations.features.html +++ b/docs/dyn/gkehub_v1alpha.projects.locations.features.html @@ -199,6 +199,13 @@

Method Details

"identityservice": { # **Anthos Identity Service**: Configuration for a single Membership. # Identity Service-specific spec. "authMethods": [ # A member may support multiple auth methods. { # Configuration of an auth method for a member/cluster. Only one authentication method (e.g., OIDC and LDAP) can be set per AuthMethod. + "azureadConfig": { # Configuration for the AzureAD Auth flow. # AzureAD specific Configuration. + "clientId": "A String", # ID for the registered client application that makes authentication requests to the Azure AD identity provider. + "clientSecret": "A String", # Raw client secret will be passed to the GKE Hub CLH. + "encryptedClientSecret": "A String", # Encrypted AzureAD client secrets + "kubectlRedirectUri": "A String", # The redirect URL that kubectl uses for authorization. + "tenant": "A String", # Kind of Azure AD account to be authenticated. Supported values are or for accounts belonging to a specific tenant. + }, "name": "A String", # Identifier for auth config. "oidcConfig": { # Configuration for OIDC Auth flow. # OIDC specific configuration. "certificateAuthorityData": "A String", # PEM-encoded CA for OIDC provider. @@ -413,6 +420,13 @@

Method Details

"memberConfig": { # **Anthos Identity Service**: Configuration for a single Membership. # Last reconciled membership configuration "authMethods": [ # A member may support multiple auth methods. { # Configuration of an auth method for a member/cluster. Only one authentication method (e.g., OIDC and LDAP) can be set per AuthMethod. + "azureadConfig": { # Configuration for the AzureAD Auth flow. # AzureAD specific Configuration. + "clientId": "A String", # ID for the registered client application that makes authentication requests to the Azure AD identity provider. + "clientSecret": "A String", # Raw client secret will be passed to the GKE Hub CLH. + "encryptedClientSecret": "A String", # Encrypted AzureAD client secrets + "kubectlRedirectUri": "A String", # The redirect URL that kubectl uses for authorization. + "tenant": "A String", # Kind of Azure AD account to be authenticated. Supported values are or for accounts belonging to a specific tenant. + }, "name": "A String", # Identifier for auth config. "oidcConfig": { # Configuration for OIDC Auth flow. # OIDC specific configuration. "certificateAuthorityData": "A String", # PEM-encoded CA for OIDC provider. @@ -749,6 +763,13 @@

Method Details

"identityservice": { # **Anthos Identity Service**: Configuration for a single Membership. # Identity Service-specific spec. "authMethods": [ # A member may support multiple auth methods. { # Configuration of an auth method for a member/cluster. Only one authentication method (e.g., OIDC and LDAP) can be set per AuthMethod. + "azureadConfig": { # Configuration for the AzureAD Auth flow. # AzureAD specific Configuration. + "clientId": "A String", # ID for the registered client application that makes authentication requests to the Azure AD identity provider. + "clientSecret": "A String", # Raw client secret will be passed to the GKE Hub CLH. + "encryptedClientSecret": "A String", # Encrypted AzureAD client secrets + "kubectlRedirectUri": "A String", # The redirect URL that kubectl uses for authorization. + "tenant": "A String", # Kind of Azure AD account to be authenticated. Supported values are or for accounts belonging to a specific tenant. + }, "name": "A String", # Identifier for auth config. "oidcConfig": { # Configuration for OIDC Auth flow. # OIDC specific configuration. "certificateAuthorityData": "A String", # PEM-encoded CA for OIDC provider. @@ -963,6 +984,13 @@

Method Details

"memberConfig": { # **Anthos Identity Service**: Configuration for a single Membership. # Last reconciled membership configuration "authMethods": [ # A member may support multiple auth methods. { # Configuration of an auth method for a member/cluster. Only one authentication method (e.g., OIDC and LDAP) can be set per AuthMethod. + "azureadConfig": { # Configuration for the AzureAD Auth flow. # AzureAD specific Configuration. + "clientId": "A String", # ID for the registered client application that makes authentication requests to the Azure AD identity provider. + "clientSecret": "A String", # Raw client secret will be passed to the GKE Hub CLH. + "encryptedClientSecret": "A String", # Encrypted AzureAD client secrets + "kubectlRedirectUri": "A String", # The redirect URL that kubectl uses for authorization. + "tenant": "A String", # Kind of Azure AD account to be authenticated. Supported values are or for accounts belonging to a specific tenant. + }, "name": "A String", # Identifier for auth config. "oidcConfig": { # Configuration for OIDC Auth flow. # OIDC specific configuration. "certificateAuthorityData": "A String", # PEM-encoded CA for OIDC provider. @@ -1287,6 +1315,13 @@

Method Details

"identityservice": { # **Anthos Identity Service**: Configuration for a single Membership. # Identity Service-specific spec. "authMethods": [ # A member may support multiple auth methods. { # Configuration of an auth method for a member/cluster. Only one authentication method (e.g., OIDC and LDAP) can be set per AuthMethod. + "azureadConfig": { # Configuration for the AzureAD Auth flow. # AzureAD specific Configuration. + "clientId": "A String", # ID for the registered client application that makes authentication requests to the Azure AD identity provider. + "clientSecret": "A String", # Raw client secret will be passed to the GKE Hub CLH. + "encryptedClientSecret": "A String", # Encrypted AzureAD client secrets + "kubectlRedirectUri": "A String", # The redirect URL that kubectl uses for authorization. + "tenant": "A String", # Kind of Azure AD account to be authenticated. Supported values are or for accounts belonging to a specific tenant. + }, "name": "A String", # Identifier for auth config. "oidcConfig": { # Configuration for OIDC Auth flow. # OIDC specific configuration. "certificateAuthorityData": "A String", # PEM-encoded CA for OIDC provider. @@ -1501,6 +1536,13 @@

Method Details

"memberConfig": { # **Anthos Identity Service**: Configuration for a single Membership. # Last reconciled membership configuration "authMethods": [ # A member may support multiple auth methods. { # Configuration of an auth method for a member/cluster. Only one authentication method (e.g., OIDC and LDAP) can be set per AuthMethod. + "azureadConfig": { # Configuration for the AzureAD Auth flow. # AzureAD specific Configuration. + "clientId": "A String", # ID for the registered client application that makes authentication requests to the Azure AD identity provider. + "clientSecret": "A String", # Raw client secret will be passed to the GKE Hub CLH. + "encryptedClientSecret": "A String", # Encrypted AzureAD client secrets + "kubectlRedirectUri": "A String", # The redirect URL that kubectl uses for authorization. + "tenant": "A String", # Kind of Azure AD account to be authenticated. Supported values are or for accounts belonging to a specific tenant. + }, "name": "A String", # Identifier for auth config. "oidcConfig": { # Configuration for OIDC Auth flow. # OIDC specific configuration. "certificateAuthorityData": "A String", # PEM-encoded CA for OIDC provider. @@ -1781,6 +1823,13 @@

Method Details

"identityservice": { # **Anthos Identity Service**: Configuration for a single Membership. # Identity Service-specific spec. "authMethods": [ # A member may support multiple auth methods. { # Configuration of an auth method for a member/cluster. Only one authentication method (e.g., OIDC and LDAP) can be set per AuthMethod. + "azureadConfig": { # Configuration for the AzureAD Auth flow. # AzureAD specific Configuration. + "clientId": "A String", # ID for the registered client application that makes authentication requests to the Azure AD identity provider. + "clientSecret": "A String", # Raw client secret will be passed to the GKE Hub CLH. + "encryptedClientSecret": "A String", # Encrypted AzureAD client secrets + "kubectlRedirectUri": "A String", # The redirect URL that kubectl uses for authorization. + "tenant": "A String", # Kind of Azure AD account to be authenticated. Supported values are or for accounts belonging to a specific tenant. + }, "name": "A String", # Identifier for auth config. "oidcConfig": { # Configuration for OIDC Auth flow. # OIDC specific configuration. "certificateAuthorityData": "A String", # PEM-encoded CA for OIDC provider. @@ -1995,6 +2044,13 @@

Method Details

"memberConfig": { # **Anthos Identity Service**: Configuration for a single Membership. # Last reconciled membership configuration "authMethods": [ # A member may support multiple auth methods. { # Configuration of an auth method for a member/cluster. Only one authentication method (e.g., OIDC and LDAP) can be set per AuthMethod. + "azureadConfig": { # Configuration for the AzureAD Auth flow. # AzureAD specific Configuration. + "clientId": "A String", # ID for the registered client application that makes authentication requests to the Azure AD identity provider. + "clientSecret": "A String", # Raw client secret will be passed to the GKE Hub CLH. + "encryptedClientSecret": "A String", # Encrypted AzureAD client secrets + "kubectlRedirectUri": "A String", # The redirect URL that kubectl uses for authorization. + "tenant": "A String", # Kind of Azure AD account to be authenticated. Supported values are or for accounts belonging to a specific tenant. + }, "name": "A String", # Identifier for auth config. "oidcConfig": { # Configuration for OIDC Auth flow. # OIDC specific configuration. "certificateAuthorityData": "A String", # PEM-encoded CA for OIDC provider. diff --git a/docs/dyn/gkehub_v1beta.projects.locations.features.html b/docs/dyn/gkehub_v1beta.projects.locations.features.html index 678c1cebbfc..665d5a86cc2 100644 --- a/docs/dyn/gkehub_v1beta.projects.locations.features.html +++ b/docs/dyn/gkehub_v1beta.projects.locations.features.html @@ -235,6 +235,7 @@

Method Details

"A String", ], }, + "mutationEnabled": True or False, # Enables the ability to mutate resources using Policy Controller. "referentialRulesEnabled": True or False, # Enables the ability to use Constraint Templates that reference to objects other than the object currently being evaluated. "templateLibraryConfig": { # The config specifying which default library templates to install. # Configures the library templates to install along with Policy Controller. "included": True or False, # Whether the standard template library should be installed or not. @@ -447,6 +448,7 @@

Method Details

"A String", ], }, + "mutationEnabled": True or False, # Enables the ability to mutate resources using Policy Controller. "referentialRulesEnabled": True or False, # Enables the ability to use Constraint Templates that reference to objects other than the object currently being evaluated. "templateLibraryConfig": { # The config specifying which default library templates to install. # Configures the library templates to install along with Policy Controller. "included": True or False, # Whether the standard template library should be installed or not. @@ -715,6 +717,7 @@

Method Details

"A String", ], }, + "mutationEnabled": True or False, # Enables the ability to mutate resources using Policy Controller. "referentialRulesEnabled": True or False, # Enables the ability to use Constraint Templates that reference to objects other than the object currently being evaluated. "templateLibraryConfig": { # The config specifying which default library templates to install. # Configures the library templates to install along with Policy Controller. "included": True or False, # Whether the standard template library should be installed or not. @@ -927,6 +930,7 @@

Method Details

"A String", ], }, + "mutationEnabled": True or False, # Enables the ability to mutate resources using Policy Controller. "referentialRulesEnabled": True or False, # Enables the ability to use Constraint Templates that reference to objects other than the object currently being evaluated. "templateLibraryConfig": { # The config specifying which default library templates to install. # Configures the library templates to install along with Policy Controller. "included": True or False, # Whether the standard template library should be installed or not. @@ -1183,6 +1187,7 @@

Method Details

"A String", ], }, + "mutationEnabled": True or False, # Enables the ability to mutate resources using Policy Controller. "referentialRulesEnabled": True or False, # Enables the ability to use Constraint Templates that reference to objects other than the object currently being evaluated. "templateLibraryConfig": { # The config specifying which default library templates to install. # Configures the library templates to install along with Policy Controller. "included": True or False, # Whether the standard template library should be installed or not. @@ -1395,6 +1400,7 @@

Method Details

"A String", ], }, + "mutationEnabled": True or False, # Enables the ability to mutate resources using Policy Controller. "referentialRulesEnabled": True or False, # Enables the ability to use Constraint Templates that reference to objects other than the object currently being evaluated. "templateLibraryConfig": { # The config specifying which default library templates to install. # Configures the library templates to install along with Policy Controller. "included": True or False, # Whether the standard template library should be installed or not. @@ -1607,6 +1613,7 @@

Method Details

"A String", ], }, + "mutationEnabled": True or False, # Enables the ability to mutate resources using Policy Controller. "referentialRulesEnabled": True or False, # Enables the ability to use Constraint Templates that reference to objects other than the object currently being evaluated. "templateLibraryConfig": { # The config specifying which default library templates to install. # Configures the library templates to install along with Policy Controller. "included": True or False, # Whether the standard template library should be installed or not. @@ -1819,6 +1826,7 @@

Method Details

"A String", ], }, + "mutationEnabled": True or False, # Enables the ability to mutate resources using Policy Controller. "referentialRulesEnabled": True or False, # Enables the ability to use Constraint Templates that reference to objects other than the object currently being evaluated. "templateLibraryConfig": { # The config specifying which default library templates to install. # Configures the library templates to install along with Policy Controller. "included": True or False, # Whether the standard template library should be installed or not. diff --git a/googleapiclient/discovery_cache/documents/gkehub.v1.json b/googleapiclient/discovery_cache/documents/gkehub.v1.json index ac04574016f..2d055fc6bf7 100644 --- a/googleapiclient/discovery_cache/documents/gkehub.v1.json +++ b/googleapiclient/discovery_cache/documents/gkehub.v1.json @@ -905,7 +905,7 @@ } } }, - "revision": "20220628", + "revision": "20220706", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AnthosVMMembershipSpec": { diff --git a/googleapiclient/discovery_cache/documents/gkehub.v1alpha.json b/googleapiclient/discovery_cache/documents/gkehub.v1alpha.json index 9b217a11cef..257135a26bb 100644 --- a/googleapiclient/discovery_cache/documents/gkehub.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/gkehub.v1alpha.json @@ -1151,7 +1151,7 @@ } } }, - "revision": "20220628", + "revision": "20220706", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AnthosObservabilityFeatureSpec": { @@ -2578,6 +2578,10 @@ "description": "Configuration of an auth method for a member/cluster. Only one authentication method (e.g., OIDC and LDAP) can be set per AuthMethod.", "id": "IdentityServiceAuthMethod", "properties": { + "azureadConfig": { + "$ref": "IdentityServiceAzureADConfig", + "description": "AzureAD specific Configuration." + }, "name": { "description": "Identifier for auth config.", "type": "string" @@ -2593,6 +2597,34 @@ }, "type": "object" }, + "IdentityServiceAzureADConfig": { + "description": "Configuration for the AzureAD Auth flow.", + "id": "IdentityServiceAzureADConfig", + "properties": { + "clientId": { + "description": "ID for the registered client application that makes authentication requests to the Azure AD identity provider.", + "type": "string" + }, + "clientSecret": { + "description": "Raw client secret will be passed to the GKE Hub CLH.", + "type": "string" + }, + "encryptedClientSecret": { + "description": "Encrypted AzureAD client secrets", + "format": "byte", + "type": "string" + }, + "kubectlRedirectUri": { + "description": "The redirect URL that kubectl uses for authorization.", + "type": "string" + }, + "tenant": { + "description": "Kind of Azure AD account to be authenticated. Supported values are or for accounts belonging to a specific tenant.", + "type": "string" + } + }, + "type": "object" + }, "IdentityServiceMembershipSpec": { "description": "**Anthos Identity Service**: Configuration for a single Membership.", "id": "IdentityServiceMembershipSpec", diff --git a/googleapiclient/discovery_cache/documents/gkehub.v1alpha2.json b/googleapiclient/discovery_cache/documents/gkehub.v1alpha2.json index e23bcaf51f7..2a7ff366272 100644 --- a/googleapiclient/discovery_cache/documents/gkehub.v1alpha2.json +++ b/googleapiclient/discovery_cache/documents/gkehub.v1alpha2.json @@ -652,7 +652,7 @@ } } }, - "revision": "20220628", + "revision": "20220706", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "ApplianceCluster": { diff --git a/googleapiclient/discovery_cache/documents/gkehub.v1beta.json b/googleapiclient/discovery_cache/documents/gkehub.v1beta.json index 30aa5845236..7061dbbb440 100644 --- a/googleapiclient/discovery_cache/documents/gkehub.v1beta.json +++ b/googleapiclient/discovery_cache/documents/gkehub.v1beta.json @@ -670,7 +670,7 @@ } } }, - "revision": "20220628", + "revision": "20220706", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AnthosObservabilityFeatureSpec": { @@ -2410,6 +2410,10 @@ "$ref": "PolicyControllerMonitoringConfig", "description": "Monitoring specifies the configuration of monitoring." }, + "mutationEnabled": { + "description": "Enables the ability to mutate resources using Policy Controller.", + "type": "boolean" + }, "referentialRulesEnabled": { "description": "Enables the ability to use Constraint Templates that reference to objects other than the object currently being evaluated.", "type": "boolean" diff --git a/googleapiclient/discovery_cache/documents/gkehub.v1beta1.json b/googleapiclient/discovery_cache/documents/gkehub.v1beta1.json index 23d20a2d0d0..bc0a32991fe 100644 --- a/googleapiclient/discovery_cache/documents/gkehub.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/gkehub.v1beta1.json @@ -706,7 +706,7 @@ } } }, - "revision": "20220628", + "revision": "20220706", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "ApplianceCluster": { diff --git a/googleapiclient/discovery_cache/documents/gkehub.v2alpha.json b/googleapiclient/discovery_cache/documents/gkehub.v2alpha.json index 1e0251e393f..79dec65797a 100644 --- a/googleapiclient/discovery_cache/documents/gkehub.v2alpha.json +++ b/googleapiclient/discovery_cache/documents/gkehub.v2alpha.json @@ -280,7 +280,7 @@ } } }, - "revision": "20220628", + "revision": "20220706", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "CancelOperationRequest": { From cb875b8ddaab637aadc187e1c25268d9633b39c8 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 19 Jul 2022 07:08:14 +0000 Subject: [PATCH 17/23] feat(mybusinessaccountmanagement): update the api #### mybusinessaccountmanagement:v1 The following keys were added: - schemas.Admin.properties.account.type (Total Keys: 1) --- .../dyn/mybusinessaccountmanagement_v1.accounts.admins.html | 5 +++++ .../mybusinessaccountmanagement_v1.locations.admins.html | 5 +++++ .../documents/mybusinessaccountmanagement.v1.json | 6 +++++- 3 files changed, 15 insertions(+), 1 deletion(-) diff --git a/docs/dyn/mybusinessaccountmanagement_v1.accounts.admins.html b/docs/dyn/mybusinessaccountmanagement_v1.accounts.admins.html index 88ef70ce959..5c458418041 100644 --- a/docs/dyn/mybusinessaccountmanagement_v1.accounts.admins.html +++ b/docs/dyn/mybusinessaccountmanagement_v1.accounts.admins.html @@ -105,6 +105,7 @@

Method Details

The object takes the form of: { # An administrator of an Account or a location. + "account": "A String", # Immutable. The name of the Account resource that this Admin refers to. Used when calling CreateAccountAdmin or CreateLocationAdmin to invite UserGroups or LocationGroups as admins, respectively. If both this field and `admin` are set on `CREATE` requests, this field takes precedence and the email address in `admin` will be ignored. Format: `accounts/{account}`. "admin": "A String", # Optional. The name of the admin. When making the initial invitation, this is the invitee's email address. On `GET` calls, the user's email address is returned if the invitation is still pending. Otherwise, it contains the user's first and last names. This field is only needed to be set during admin creation. "name": "A String", # Immutable. The resource name. For account admins, this is in the form: `accounts/{account_id}/admins/{admin_id}` For location admins, this is in the form: `locations/{location_id}/admins/{admin_id}` This field will be ignored if set during admin creation. "pendingInvitation": True or False, # Output only. Indicates whether this admin has a pending invitation for the specified resource. @@ -120,6 +121,7 @@

Method Details

An object of the form: { # An administrator of an Account or a location. + "account": "A String", # Immutable. The name of the Account resource that this Admin refers to. Used when calling CreateAccountAdmin or CreateLocationAdmin to invite UserGroups or LocationGroups as admins, respectively. If both this field and `admin` are set on `CREATE` requests, this field takes precedence and the email address in `admin` will be ignored. Format: `accounts/{account}`. "admin": "A String", # Optional. The name of the admin. When making the initial invitation, this is the invitee's email address. On `GET` calls, the user's email address is returned if the invitation is still pending. Otherwise, it contains the user's first and last names. This field is only needed to be set during admin creation. "name": "A String", # Immutable. The resource name. For account admins, this is in the form: `accounts/{account_id}/admins/{admin_id}` For location admins, this is in the form: `locations/{location_id}/admins/{admin_id}` This field will be ignored if set during admin creation. "pendingInvitation": True or False, # Output only. Indicates whether this admin has a pending invitation for the specified resource. @@ -162,6 +164,7 @@

Method Details

{ # Response message for AccessControl.ListAccountAdmins. "accountAdmins": [ # A collection of Admin instances. { # An administrator of an Account or a location. + "account": "A String", # Immutable. The name of the Account resource that this Admin refers to. Used when calling CreateAccountAdmin or CreateLocationAdmin to invite UserGroups or LocationGroups as admins, respectively. If both this field and `admin` are set on `CREATE` requests, this field takes precedence and the email address in `admin` will be ignored. Format: `accounts/{account}`. "admin": "A String", # Optional. The name of the admin. When making the initial invitation, this is the invitee's email address. On `GET` calls, the user's email address is returned if the invitation is still pending. Otherwise, it contains the user's first and last names. This field is only needed to be set during admin creation. "name": "A String", # Immutable. The resource name. For account admins, this is in the form: `accounts/{account_id}/admins/{admin_id}` For location admins, this is in the form: `locations/{location_id}/admins/{admin_id}` This field will be ignored if set during admin creation. "pendingInvitation": True or False, # Output only. Indicates whether this admin has a pending invitation for the specified resource. @@ -181,6 +184,7 @@

Method Details

The object takes the form of: { # An administrator of an Account or a location. + "account": "A String", # Immutable. The name of the Account resource that this Admin refers to. Used when calling CreateAccountAdmin or CreateLocationAdmin to invite UserGroups or LocationGroups as admins, respectively. If both this field and `admin` are set on `CREATE` requests, this field takes precedence and the email address in `admin` will be ignored. Format: `accounts/{account}`. "admin": "A String", # Optional. The name of the admin. When making the initial invitation, this is the invitee's email address. On `GET` calls, the user's email address is returned if the invitation is still pending. Otherwise, it contains the user's first and last names. This field is only needed to be set during admin creation. "name": "A String", # Immutable. The resource name. For account admins, this is in the form: `accounts/{account_id}/admins/{admin_id}` For location admins, this is in the form: `locations/{location_id}/admins/{admin_id}` This field will be ignored if set during admin creation. "pendingInvitation": True or False, # Output only. Indicates whether this admin has a pending invitation for the specified resource. @@ -197,6 +201,7 @@

Method Details

An object of the form: { # An administrator of an Account or a location. + "account": "A String", # Immutable. The name of the Account resource that this Admin refers to. Used when calling CreateAccountAdmin or CreateLocationAdmin to invite UserGroups or LocationGroups as admins, respectively. If both this field and `admin` are set on `CREATE` requests, this field takes precedence and the email address in `admin` will be ignored. Format: `accounts/{account}`. "admin": "A String", # Optional. The name of the admin. When making the initial invitation, this is the invitee's email address. On `GET` calls, the user's email address is returned if the invitation is still pending. Otherwise, it contains the user's first and last names. This field is only needed to be set during admin creation. "name": "A String", # Immutable. The resource name. For account admins, this is in the form: `accounts/{account_id}/admins/{admin_id}` For location admins, this is in the form: `locations/{location_id}/admins/{admin_id}` This field will be ignored if set during admin creation. "pendingInvitation": True or False, # Output only. Indicates whether this admin has a pending invitation for the specified resource. diff --git a/docs/dyn/mybusinessaccountmanagement_v1.locations.admins.html b/docs/dyn/mybusinessaccountmanagement_v1.locations.admins.html index a028c9814e5..bd44637ba15 100644 --- a/docs/dyn/mybusinessaccountmanagement_v1.locations.admins.html +++ b/docs/dyn/mybusinessaccountmanagement_v1.locations.admins.html @@ -105,6 +105,7 @@

Method Details

The object takes the form of: { # An administrator of an Account or a location. + "account": "A String", # Immutable. The name of the Account resource that this Admin refers to. Used when calling CreateAccountAdmin or CreateLocationAdmin to invite UserGroups or LocationGroups as admins, respectively. If both this field and `admin` are set on `CREATE` requests, this field takes precedence and the email address in `admin` will be ignored. Format: `accounts/{account}`. "admin": "A String", # Optional. The name of the admin. When making the initial invitation, this is the invitee's email address. On `GET` calls, the user's email address is returned if the invitation is still pending. Otherwise, it contains the user's first and last names. This field is only needed to be set during admin creation. "name": "A String", # Immutable. The resource name. For account admins, this is in the form: `accounts/{account_id}/admins/{admin_id}` For location admins, this is in the form: `locations/{location_id}/admins/{admin_id}` This field will be ignored if set during admin creation. "pendingInvitation": True or False, # Output only. Indicates whether this admin has a pending invitation for the specified resource. @@ -120,6 +121,7 @@

Method Details

An object of the form: { # An administrator of an Account or a location. + "account": "A String", # Immutable. The name of the Account resource that this Admin refers to. Used when calling CreateAccountAdmin or CreateLocationAdmin to invite UserGroups or LocationGroups as admins, respectively. If both this field and `admin` are set on `CREATE` requests, this field takes precedence and the email address in `admin` will be ignored. Format: `accounts/{account}`. "admin": "A String", # Optional. The name of the admin. When making the initial invitation, this is the invitee's email address. On `GET` calls, the user's email address is returned if the invitation is still pending. Otherwise, it contains the user's first and last names. This field is only needed to be set during admin creation. "name": "A String", # Immutable. The resource name. For account admins, this is in the form: `accounts/{account_id}/admins/{admin_id}` For location admins, this is in the form: `locations/{location_id}/admins/{admin_id}` This field will be ignored if set during admin creation. "pendingInvitation": True or False, # Output only. Indicates whether this admin has a pending invitation for the specified resource. @@ -162,6 +164,7 @@

Method Details

{ # Response message for AccessControl.ListLocationAdmins. "admins": [ # A collection of Admins. { # An administrator of an Account or a location. + "account": "A String", # Immutable. The name of the Account resource that this Admin refers to. Used when calling CreateAccountAdmin or CreateLocationAdmin to invite UserGroups or LocationGroups as admins, respectively. If both this field and `admin` are set on `CREATE` requests, this field takes precedence and the email address in `admin` will be ignored. Format: `accounts/{account}`. "admin": "A String", # Optional. The name of the admin. When making the initial invitation, this is the invitee's email address. On `GET` calls, the user's email address is returned if the invitation is still pending. Otherwise, it contains the user's first and last names. This field is only needed to be set during admin creation. "name": "A String", # Immutable. The resource name. For account admins, this is in the form: `accounts/{account_id}/admins/{admin_id}` For location admins, this is in the form: `locations/{location_id}/admins/{admin_id}` This field will be ignored if set during admin creation. "pendingInvitation": True or False, # Output only. Indicates whether this admin has a pending invitation for the specified resource. @@ -181,6 +184,7 @@

Method Details

The object takes the form of: { # An administrator of an Account or a location. + "account": "A String", # Immutable. The name of the Account resource that this Admin refers to. Used when calling CreateAccountAdmin or CreateLocationAdmin to invite UserGroups or LocationGroups as admins, respectively. If both this field and `admin` are set on `CREATE` requests, this field takes precedence and the email address in `admin` will be ignored. Format: `accounts/{account}`. "admin": "A String", # Optional. The name of the admin. When making the initial invitation, this is the invitee's email address. On `GET` calls, the user's email address is returned if the invitation is still pending. Otherwise, it contains the user's first and last names. This field is only needed to be set during admin creation. "name": "A String", # Immutable. The resource name. For account admins, this is in the form: `accounts/{account_id}/admins/{admin_id}` For location admins, this is in the form: `locations/{location_id}/admins/{admin_id}` This field will be ignored if set during admin creation. "pendingInvitation": True or False, # Output only. Indicates whether this admin has a pending invitation for the specified resource. @@ -197,6 +201,7 @@

Method Details

An object of the form: { # An administrator of an Account or a location. + "account": "A String", # Immutable. The name of the Account resource that this Admin refers to. Used when calling CreateAccountAdmin or CreateLocationAdmin to invite UserGroups or LocationGroups as admins, respectively. If both this field and `admin` are set on `CREATE` requests, this field takes precedence and the email address in `admin` will be ignored. Format: `accounts/{account}`. "admin": "A String", # Optional. The name of the admin. When making the initial invitation, this is the invitee's email address. On `GET` calls, the user's email address is returned if the invitation is still pending. Otherwise, it contains the user's first and last names. This field is only needed to be set during admin creation. "name": "A String", # Immutable. The resource name. For account admins, this is in the form: `accounts/{account_id}/admins/{admin_id}` For location admins, this is in the form: `locations/{location_id}/admins/{admin_id}` This field will be ignored if set during admin creation. "pendingInvitation": True or False, # Output only. Indicates whether this admin has a pending invitation for the specified resource. diff --git a/googleapiclient/discovery_cache/documents/mybusinessaccountmanagement.v1.json b/googleapiclient/discovery_cache/documents/mybusinessaccountmanagement.v1.json index e9416dbf56d..aa8f1c8bea1 100644 --- a/googleapiclient/discovery_cache/documents/mybusinessaccountmanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/mybusinessaccountmanagement.v1.json @@ -530,7 +530,7 @@ } } }, - "revision": "20220708", + "revision": "20220716", "rootUrl": "https://mybusinessaccountmanagement.googleapis.com/", "schemas": { "AcceptInvitationRequest": { @@ -658,6 +658,10 @@ "description": "An administrator of an Account or a location.", "id": "Admin", "properties": { + "account": { + "description": "Immutable. The name of the Account resource that this Admin refers to. Used when calling CreateAccountAdmin or CreateLocationAdmin to invite UserGroups or LocationGroups as admins, respectively. If both this field and `admin` are set on `CREATE` requests, this field takes precedence and the email address in `admin` will be ignored. Format: `accounts/{account}`.", + "type": "string" + }, "admin": { "description": "Optional. The name of the admin. When making the initial invitation, this is the invitee's email address. On `GET` calls, the user's email address is returned if the invitation is still pending. Otherwise, it contains the user's first and last names. This field is only needed to be set during admin creation.", "type": "string" From 68e45cdf1cce8a7be282369dc027113dc61c2d39 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 19 Jul 2022 07:08:14 +0000 Subject: [PATCH 18/23] feat(ondemandscanning): update the api #### ondemandscanning:v1 The following keys were added: - schemas.AnalysisCompleted (Total Keys: 4) - schemas.DiscoveryOccurrence.properties.analysisCompleted.$ref (Total Keys: 1) - schemas.DiscoveryOccurrence.properties.analysisError (Total Keys: 2) #### ondemandscanning:v1beta1 The following keys were added: - schemas.AnalysisCompleted (Total Keys: 4) - schemas.DiscoveryOccurrence.properties.analysisCompleted.$ref (Total Keys: 1) - schemas.DiscoveryOccurrence.properties.analysisError (Total Keys: 2) --- ...jects.locations.scans.vulnerabilities.html | 16 ++++++++++ ...jects.locations.scans.vulnerabilities.html | 16 ++++++++++ .../documents/ondemandscanning.v1.json | 29 +++++++++++++++++-- .../documents/ondemandscanning.v1beta1.json | 29 +++++++++++++++++-- 4 files changed, 86 insertions(+), 4 deletions(-) diff --git a/docs/dyn/ondemandscanning_v1.projects.locations.scans.vulnerabilities.html b/docs/dyn/ondemandscanning_v1.projects.locations.scans.vulnerabilities.html index 3dddf98ce04..2105a64294d 100644 --- a/docs/dyn/ondemandscanning_v1.projects.locations.scans.vulnerabilities.html +++ b/docs/dyn/ondemandscanning_v1.projects.locations.scans.vulnerabilities.html @@ -425,6 +425,22 @@

Method Details

"userEmail": "A String", # Identity of the user that triggered this deployment. }, "discovery": { # Provides information about the analysis status of a discovered resource. # Describes when a resource was discovered. + "analysisCompleted": { # Indicates which analysis completed successfully. Multiple types of analysis can be performed on a single resource. + "analysisType": [ + "A String", + ], + }, + "analysisError": [ # Indicates any errors encountered during analysis of a resource. There could be 0 or more of these errors. + { # 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). + "code": 42, # The status code, which should be an enum value of google.rpc.Code. + "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. + { + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + ], + "message": "A String", # 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. + }, + ], "analysisStatus": "A String", # The status of discovery for the resource. "analysisStatusError": { # 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). # When an error is encountered this will contain a LocalizedMessage under details to show to the user. The LocalizedMessage is output only and populated by the API. "code": 42, # The status code, which should be an enum value of google.rpc.Code. diff --git a/docs/dyn/ondemandscanning_v1beta1.projects.locations.scans.vulnerabilities.html b/docs/dyn/ondemandscanning_v1beta1.projects.locations.scans.vulnerabilities.html index 7c53148b033..fcdd5cd0c7d 100644 --- a/docs/dyn/ondemandscanning_v1beta1.projects.locations.scans.vulnerabilities.html +++ b/docs/dyn/ondemandscanning_v1beta1.projects.locations.scans.vulnerabilities.html @@ -425,6 +425,22 @@

Method Details

"userEmail": "A String", # Identity of the user that triggered this deployment. }, "discovery": { # Provides information about the analysis status of a discovered resource. # Describes when a resource was discovered. + "analysisCompleted": { # Indicates which analysis completed successfully. Multiple types of analysis can be performed on a single resource. + "analysisType": [ + "A String", + ], + }, + "analysisError": [ # Indicates any errors encountered during analysis of a resource. There could be 0 or more of these errors. + { # 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). + "code": 42, # The status code, which should be an enum value of google.rpc.Code. + "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. + { + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + ], + "message": "A String", # 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. + }, + ], "analysisStatus": "A String", # The status of discovery for the resource. "analysisStatusError": { # 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). # When an error is encountered this will contain a LocalizedMessage under details to show to the user. The LocalizedMessage is output only and populated by the API. "code": 42, # The status code, which should be an enum value of google.rpc.Code. diff --git a/googleapiclient/discovery_cache/documents/ondemandscanning.v1.json b/googleapiclient/discovery_cache/documents/ondemandscanning.v1.json index 6585a8869bf..784d9ee4dca 100644 --- a/googleapiclient/discovery_cache/documents/ondemandscanning.v1.json +++ b/googleapiclient/discovery_cache/documents/ondemandscanning.v1.json @@ -339,7 +339,7 @@ } } }, - "revision": "20220625", + "revision": "20220711", "rootUrl": "https://ondemandscanning.googleapis.com/", "schemas": { "AliasContext": { @@ -369,6 +369,19 @@ }, "type": "object" }, + "AnalysisCompleted": { + "description": "Indicates which analysis completed successfully. Multiple types of analysis can be performed on a single resource.", + "id": "AnalysisCompleted", + "properties": { + "analysisType": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "AnalyzePackagesMetadata": { "description": "AnalyzePackagesMetadata contains metadata for an active scan of a container image.", "id": "AnalyzePackagesMetadata", @@ -927,6 +940,16 @@ "description": "Provides information about the analysis status of a discovered resource.", "id": "DiscoveryOccurrence", "properties": { + "analysisCompleted": { + "$ref": "AnalysisCompleted" + }, + "analysisError": { + "description": "Indicates any errors encountered during analysis of a resource. There could be 0 or more of these errors.", + "items": { + "$ref": "Status" + }, + "type": "array" + }, "analysisStatus": { "description": "The status of discovery for the resource.", "enum": [ @@ -934,6 +957,7 @@ "PENDING", "SCANNING", "FINISHED_SUCCESS", + "COMPLETE", "FINISHED_FAILED", "FINISHED_UNSUPPORTED" ], @@ -942,8 +966,9 @@ "Resource is known but no action has been taken yet.", "Resource is being analyzed.", "Analysis has finished successfully.", + "Analysis has completed", "Analysis has finished unsuccessfully, the analysis itself is in a bad state.", - "The resource is known not to be supported" + "The resource is known not to be supported." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/ondemandscanning.v1beta1.json b/googleapiclient/discovery_cache/documents/ondemandscanning.v1beta1.json index faf7ea32626..6208752485f 100644 --- a/googleapiclient/discovery_cache/documents/ondemandscanning.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/ondemandscanning.v1beta1.json @@ -339,7 +339,7 @@ } } }, - "revision": "20220625", + "revision": "20220711", "rootUrl": "https://ondemandscanning.googleapis.com/", "schemas": { "AliasContext": { @@ -369,6 +369,19 @@ }, "type": "object" }, + "AnalysisCompleted": { + "description": "Indicates which analysis completed successfully. Multiple types of analysis can be performed on a single resource.", + "id": "AnalysisCompleted", + "properties": { + "analysisType": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "AnalyzePackagesMetadata": { "description": "AnalyzePackagesMetadata contains metadata for an active scan of a container image.", "id": "AnalyzePackagesMetadata", @@ -923,6 +936,16 @@ "description": "Provides information about the analysis status of a discovered resource.", "id": "DiscoveryOccurrence", "properties": { + "analysisCompleted": { + "$ref": "AnalysisCompleted" + }, + "analysisError": { + "description": "Indicates any errors encountered during analysis of a resource. There could be 0 or more of these errors.", + "items": { + "$ref": "Status" + }, + "type": "array" + }, "analysisStatus": { "description": "The status of discovery for the resource.", "enum": [ @@ -930,6 +953,7 @@ "PENDING", "SCANNING", "FINISHED_SUCCESS", + "COMPLETE", "FINISHED_FAILED", "FINISHED_UNSUPPORTED" ], @@ -938,8 +962,9 @@ "Resource is known but no action has been taken yet.", "Resource is being analyzed.", "Analysis has finished successfully.", + "Analysis has completed", "Analysis has finished unsuccessfully, the analysis itself is in a bad state.", - "The resource is known not to be supported" + "The resource is known not to be supported." ], "type": "string" }, From daf5183d0c6bdb2ae0a75be0a409171c2f26360d Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 19 Jul 2022 07:08:15 +0000 Subject: [PATCH 19/23] feat(run): update the api #### run:v2 The following keys were added: - schemas.GoogleCloudRunV2Container.properties.workingDir.type (Total Keys: 1) --- docs/dyn/run_v1.namespaces.configurations.html | 4 ++-- docs/dyn/run_v1.namespaces.executions.html | 4 ++-- docs/dyn/run_v1.namespaces.jobs.html | 14 +++++++------- docs/dyn/run_v1.namespaces.revisions.html | 4 ++-- docs/dyn/run_v1.namespaces.services.html | 12 ++++++------ docs/dyn/run_v1.namespaces.tasks.html | 4 ++-- .../run_v1.projects.locations.configurations.html | 4 ++-- docs/dyn/run_v1.projects.locations.revisions.html | 4 ++-- docs/dyn/run_v1.projects.locations.services.html | 12 ++++++------ docs/dyn/run_v1alpha1.namespaces.jobs.html | 8 ++++---- .../run_v2.projects.locations.jobs.executions.html | 6 ++++-- ...2.projects.locations.jobs.executions.tasks.html | 6 ++++-- docs/dyn/run_v2.projects.locations.jobs.html | 12 ++++++++---- docs/dyn/run_v2.projects.locations.services.html | 12 ++++++++---- ...n_v2.projects.locations.services.revisions.html | 6 ++++-- .../discovery_cache/documents/run.v1.json | 4 ++-- .../discovery_cache/documents/run.v1alpha1.json | 4 ++-- .../discovery_cache/documents/run.v2.json | 14 ++++++++++---- 18 files changed, 77 insertions(+), 57 deletions(-) diff --git a/docs/dyn/run_v1.namespaces.configurations.html b/docs/dyn/run_v1.namespaces.configurations.html index af4acd2c92f..774e8a052ef 100644 --- a/docs/dyn/run_v1.namespaces.configurations.html +++ b/docs/dyn/run_v1.namespaces.configurations.html @@ -376,7 +376,7 @@

Method Details

}, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. "secret": { # The secret's value will be presented as the content of a file whose name is defined in the item path. If no items are defined, the name of the file is the secret_name. The contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the file names. - "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 01 and 0777 (octal). If 0 or not set, it will default to 0644. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. + "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 01 and 0777 (octal). If 0 or not set, it will default to 0444. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. "items": [ # (Optional) If unspecified, the volume will expose a file whose name is the secret_name. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a key and a path. If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified that is not present in the Secret, the volume setup will error unless it is marked optional. { # Maps a string key to a path within a volume. "key": "A String", # The Cloud Secret Manager secret version. Can be 'latest' for the latest value or an integer for a specific version. The key to project. @@ -707,7 +707,7 @@

Method Details

}, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. "secret": { # The secret's value will be presented as the content of a file whose name is defined in the item path. If no items are defined, the name of the file is the secret_name. The contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the file names. - "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 01 and 0777 (octal). If 0 or not set, it will default to 0644. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. + "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 01 and 0777 (octal). If 0 or not set, it will default to 0444. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. "items": [ # (Optional) If unspecified, the volume will expose a file whose name is the secret_name. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a key and a path. If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified that is not present in the Secret, the volume setup will error unless it is marked optional. { # Maps a string key to a path within a volume. "key": "A String", # The Cloud Secret Manager secret version. Can be 'latest' for the latest value or an integer for a specific version. The key to project. diff --git a/docs/dyn/run_v1.namespaces.executions.html b/docs/dyn/run_v1.namespaces.executions.html index 15387c06cb6..61eec1c31b2 100644 --- a/docs/dyn/run_v1.namespaces.executions.html +++ b/docs/dyn/run_v1.namespaces.executions.html @@ -387,7 +387,7 @@

Method Details

}, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. "secret": { # The secret's value will be presented as the content of a file whose name is defined in the item path. If no items are defined, the name of the file is the secret_name. The contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the file names. - "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 01 and 0777 (octal). If 0 or not set, it will default to 0644. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. + "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 01 and 0777 (octal). If 0 or not set, it will default to 0444. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. "items": [ # (Optional) If unspecified, the volume will expose a file whose name is the secret_name. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a key and a path. If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified that is not present in the Secret, the volume setup will error unless it is marked optional. { # Maps a string key to a path within a volume. "key": "A String", # The Cloud Secret Manager secret version. Can be 'latest' for the latest value or an integer for a specific version. The key to project. @@ -688,7 +688,7 @@

Method Details

}, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. "secret": { # The secret's value will be presented as the content of a file whose name is defined in the item path. If no items are defined, the name of the file is the secret_name. The contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the file names. - "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 01 and 0777 (octal). If 0 or not set, it will default to 0644. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. + "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 01 and 0777 (octal). If 0 or not set, it will default to 0444. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. "items": [ # (Optional) If unspecified, the volume will expose a file whose name is the secret_name. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a key and a path. If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified that is not present in the Secret, the volume setup will error unless it is marked optional. { # Maps a string key to a path within a volume. "key": "A String", # The Cloud Secret Manager secret version. Can be 'latest' for the latest value or an integer for a specific version. The key to project. diff --git a/docs/dyn/run_v1.namespaces.jobs.html b/docs/dyn/run_v1.namespaces.jobs.html index 3e94be76e73..2a603b3b25c 100644 --- a/docs/dyn/run_v1.namespaces.jobs.html +++ b/docs/dyn/run_v1.namespaces.jobs.html @@ -381,7 +381,7 @@

Method Details

}, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. "secret": { # The secret's value will be presented as the content of a file whose name is defined in the item path. If no items are defined, the name of the file is the secret_name. The contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the file names. - "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 01 and 0777 (octal). If 0 or not set, it will default to 0644. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. + "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 01 and 0777 (octal). If 0 or not set, it will default to 0444. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. "items": [ # (Optional) If unspecified, the volume will expose a file whose name is the secret_name. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a key and a path. If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified that is not present in the Secret, the volume setup will error unless it is marked optional. { # Maps a string key to a path within a volume. "key": "A String", # The Cloud Secret Manager secret version. Can be 'latest' for the latest value or an integer for a specific version. The key to project. @@ -699,7 +699,7 @@

Method Details

}, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. "secret": { # The secret's value will be presented as the content of a file whose name is defined in the item path. If no items are defined, the name of the file is the secret_name. The contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the file names. - "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 01 and 0777 (octal). If 0 or not set, it will default to 0644. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. + "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 01 and 0777 (octal). If 0 or not set, it will default to 0444. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. "items": [ # (Optional) If unspecified, the volume will expose a file whose name is the secret_name. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a key and a path. If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified that is not present in the Secret, the volume setup will error unless it is marked optional. { # Maps a string key to a path within a volume. "key": "A String", # The Cloud Secret Manager secret version. Can be 'latest' for the latest value or an integer for a specific version. The key to project. @@ -1068,7 +1068,7 @@

Method Details

}, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. "secret": { # The secret's value will be presented as the content of a file whose name is defined in the item path. If no items are defined, the name of the file is the secret_name. The contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the file names. - "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 01 and 0777 (octal). If 0 or not set, it will default to 0644. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. + "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 01 and 0777 (octal). If 0 or not set, it will default to 0444. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. "items": [ # (Optional) If unspecified, the volume will expose a file whose name is the secret_name. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a key and a path. If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified that is not present in the Secret, the volume setup will error unless it is marked optional. { # Maps a string key to a path within a volume. "key": "A String", # The Cloud Secret Manager secret version. Can be 'latest' for the latest value or an integer for a specific version. The key to project. @@ -1403,7 +1403,7 @@

Method Details

}, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. "secret": { # The secret's value will be presented as the content of a file whose name is defined in the item path. If no items are defined, the name of the file is the secret_name. The contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the file names. - "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 01 and 0777 (octal). If 0 or not set, it will default to 0644. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. + "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 01 and 0777 (octal). If 0 or not set, it will default to 0444. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. "items": [ # (Optional) If unspecified, the volume will expose a file whose name is the secret_name. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a key and a path. If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified that is not present in the Secret, the volume setup will error unless it is marked optional. { # Maps a string key to a path within a volume. "key": "A String", # The Cloud Secret Manager secret version. Can be 'latest' for the latest value or an integer for a specific version. The key to project. @@ -1734,7 +1734,7 @@

Method Details

}, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. "secret": { # The secret's value will be presented as the content of a file whose name is defined in the item path. If no items are defined, the name of the file is the secret_name. The contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the file names. - "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 01 and 0777 (octal). If 0 or not set, it will default to 0644. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. + "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 01 and 0777 (octal). If 0 or not set, it will default to 0444. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. "items": [ # (Optional) If unspecified, the volume will expose a file whose name is the secret_name. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a key and a path. If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified that is not present in the Secret, the volume setup will error unless it is marked optional. { # Maps a string key to a path within a volume. "key": "A String", # The Cloud Secret Manager secret version. Can be 'latest' for the latest value or an integer for a specific version. The key to project. @@ -2052,7 +2052,7 @@

Method Details

}, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. "secret": { # The secret's value will be presented as the content of a file whose name is defined in the item path. If no items are defined, the name of the file is the secret_name. The contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the file names. - "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 01 and 0777 (octal). If 0 or not set, it will default to 0644. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. + "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 01 and 0777 (octal). If 0 or not set, it will default to 0444. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. "items": [ # (Optional) If unspecified, the volume will expose a file whose name is the secret_name. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a key and a path. If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified that is not present in the Secret, the volume setup will error unless it is marked optional. { # Maps a string key to a path within a volume. "key": "A String", # The Cloud Secret Manager secret version. Can be 'latest' for the latest value or an integer for a specific version. The key to project. @@ -2349,7 +2349,7 @@

Method Details

}, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. "secret": { # The secret's value will be presented as the content of a file whose name is defined in the item path. If no items are defined, the name of the file is the secret_name. The contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the file names. - "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 01 and 0777 (octal). If 0 or not set, it will default to 0644. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. + "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 01 and 0777 (octal). If 0 or not set, it will default to 0444. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. "items": [ # (Optional) If unspecified, the volume will expose a file whose name is the secret_name. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a key and a path. If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified that is not present in the Secret, the volume setup will error unless it is marked optional. { # Maps a string key to a path within a volume. "key": "A String", # The Cloud Secret Manager secret version. Can be 'latest' for the latest value or an integer for a specific version. The key to project. diff --git a/docs/dyn/run_v1.namespaces.revisions.html b/docs/dyn/run_v1.namespaces.revisions.html index 291fc16565f..35fda00da66 100644 --- a/docs/dyn/run_v1.namespaces.revisions.html +++ b/docs/dyn/run_v1.namespaces.revisions.html @@ -390,7 +390,7 @@

Method Details

}, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. "secret": { # The secret's value will be presented as the content of a file whose name is defined in the item path. If no items are defined, the name of the file is the secret_name. The contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the file names. - "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 01 and 0777 (octal). If 0 or not set, it will default to 0644. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. + "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 01 and 0777 (octal). If 0 or not set, it will default to 0444. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. "items": [ # (Optional) If unspecified, the volume will expose a file whose name is the secret_name. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a key and a path. If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified that is not present in the Secret, the volume setup will error unless it is marked optional. { # Maps a string key to a path within a volume. "key": "A String", # The Cloud Secret Manager secret version. Can be 'latest' for the latest value or an integer for a specific version. The key to project. @@ -686,7 +686,7 @@

Method Details

}, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. "secret": { # The secret's value will be presented as the content of a file whose name is defined in the item path. If no items are defined, the name of the file is the secret_name. The contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the file names. - "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 01 and 0777 (octal). If 0 or not set, it will default to 0644. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. + "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 01 and 0777 (octal). If 0 or not set, it will default to 0444. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. "items": [ # (Optional) If unspecified, the volume will expose a file whose name is the secret_name. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a key and a path. If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified that is not present in the Secret, the volume setup will error unless it is marked optional. { # Maps a string key to a path within a volume. "key": "A String", # The Cloud Secret Manager secret version. Can be 'latest' for the latest value or an integer for a specific version. The key to project. diff --git a/docs/dyn/run_v1.namespaces.services.html b/docs/dyn/run_v1.namespaces.services.html index f044b26eb25..b06f9a1d016 100644 --- a/docs/dyn/run_v1.namespaces.services.html +++ b/docs/dyn/run_v1.namespaces.services.html @@ -380,7 +380,7 @@

Method Details

}, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. "secret": { # The secret's value will be presented as the content of a file whose name is defined in the item path. If no items are defined, the name of the file is the secret_name. The contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the file names. - "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 01 and 0777 (octal). If 0 or not set, it will default to 0644. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. + "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 01 and 0777 (octal). If 0 or not set, it will default to 0444. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. "items": [ # (Optional) If unspecified, the volume will expose a file whose name is the secret_name. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a key and a path. If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified that is not present in the Secret, the volume setup will error unless it is marked optional. { # Maps a string key to a path within a volume. "key": "A String", # The Cloud Secret Manager secret version. Can be 'latest' for the latest value or an integer for a specific version. The key to project. @@ -719,7 +719,7 @@

Method Details

}, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. "secret": { # The secret's value will be presented as the content of a file whose name is defined in the item path. If no items are defined, the name of the file is the secret_name. The contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the file names. - "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 01 and 0777 (octal). If 0 or not set, it will default to 0644. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. + "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 01 and 0777 (octal). If 0 or not set, it will default to 0444. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. "items": [ # (Optional) If unspecified, the volume will expose a file whose name is the secret_name. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a key and a path. If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified that is not present in the Secret, the volume setup will error unless it is marked optional. { # Maps a string key to a path within a volume. "key": "A String", # The Cloud Secret Manager secret version. Can be 'latest' for the latest value or an integer for a specific version. The key to project. @@ -1109,7 +1109,7 @@

Method Details

}, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. "secret": { # The secret's value will be presented as the content of a file whose name is defined in the item path. If no items are defined, the name of the file is the secret_name. The contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the file names. - "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 01 and 0777 (octal). If 0 or not set, it will default to 0644. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. + "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 01 and 0777 (octal). If 0 or not set, it will default to 0444. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. "items": [ # (Optional) If unspecified, the volume will expose a file whose name is the secret_name. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a key and a path. If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified that is not present in the Secret, the volume setup will error unless it is marked optional. { # Maps a string key to a path within a volume. "key": "A String", # The Cloud Secret Manager secret version. Can be 'latest' for the latest value or an integer for a specific version. The key to project. @@ -1464,7 +1464,7 @@

Method Details

}, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. "secret": { # The secret's value will be presented as the content of a file whose name is defined in the item path. If no items are defined, the name of the file is the secret_name. The contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the file names. - "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 01 and 0777 (octal). If 0 or not set, it will default to 0644. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. + "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 01 and 0777 (octal). If 0 or not set, it will default to 0444. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. "items": [ # (Optional) If unspecified, the volume will expose a file whose name is the secret_name. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a key and a path. If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified that is not present in the Secret, the volume setup will error unless it is marked optional. { # Maps a string key to a path within a volume. "key": "A String", # The Cloud Secret Manager secret version. Can be 'latest' for the latest value or an integer for a specific version. The key to project. @@ -1815,7 +1815,7 @@

Method Details

}, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. "secret": { # The secret's value will be presented as the content of a file whose name is defined in the item path. If no items are defined, the name of the file is the secret_name. The contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the file names. - "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 01 and 0777 (octal). If 0 or not set, it will default to 0644. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. + "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 01 and 0777 (octal). If 0 or not set, it will default to 0444. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. "items": [ # (Optional) If unspecified, the volume will expose a file whose name is the secret_name. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a key and a path. If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified that is not present in the Secret, the volume setup will error unless it is marked optional. { # Maps a string key to a path within a volume. "key": "A String", # The Cloud Secret Manager secret version. Can be 'latest' for the latest value or an integer for a specific version. The key to project. @@ -2154,7 +2154,7 @@

Method Details

}, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. "secret": { # The secret's value will be presented as the content of a file whose name is defined in the item path. If no items are defined, the name of the file is the secret_name. The contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the file names. - "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 01 and 0777 (octal). If 0 or not set, it will default to 0644. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. + "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 01 and 0777 (octal). If 0 or not set, it will default to 0444. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. "items": [ # (Optional) If unspecified, the volume will expose a file whose name is the secret_name. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a key and a path. If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified that is not present in the Secret, the volume setup will error unless it is marked optional. { # Maps a string key to a path within a volume. "key": "A String", # The Cloud Secret Manager secret version. Can be 'latest' for the latest value or an integer for a specific version. The key to project. diff --git a/docs/dyn/run_v1.namespaces.tasks.html b/docs/dyn/run_v1.namespaces.tasks.html index d05022e6f47..6e3e955d8f1 100644 --- a/docs/dyn/run_v1.namespaces.tasks.html +++ b/docs/dyn/run_v1.namespaces.tasks.html @@ -336,7 +336,7 @@

Method Details

}, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. "secret": { # The secret's value will be presented as the content of a file whose name is defined in the item path. If no items are defined, the name of the file is the secret_name. The contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the file names. - "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 01 and 0777 (octal). If 0 or not set, it will default to 0644. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. + "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 01 and 0777 (octal). If 0 or not set, it will default to 0444. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. "items": [ # (Optional) If unspecified, the volume will expose a file whose name is the secret_name. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a key and a path. If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified that is not present in the Secret, the volume setup will error unless it is marked optional. { # Maps a string key to a path within a volume. "key": "A String", # The Cloud Secret Manager secret version. Can be 'latest' for the latest value or an integer for a specific version. The key to project. @@ -640,7 +640,7 @@

Method Details

}, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. "secret": { # The secret's value will be presented as the content of a file whose name is defined in the item path. If no items are defined, the name of the file is the secret_name. The contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the file names. - "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 01 and 0777 (octal). If 0 or not set, it will default to 0644. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. + "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 01 and 0777 (octal). If 0 or not set, it will default to 0444. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. "items": [ # (Optional) If unspecified, the volume will expose a file whose name is the secret_name. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a key and a path. If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified that is not present in the Secret, the volume setup will error unless it is marked optional. { # Maps a string key to a path within a volume. "key": "A String", # The Cloud Secret Manager secret version. Can be 'latest' for the latest value or an integer for a specific version. The key to project. diff --git a/docs/dyn/run_v1.projects.locations.configurations.html b/docs/dyn/run_v1.projects.locations.configurations.html index 6d350c004c0..cdff53b9364 100644 --- a/docs/dyn/run_v1.projects.locations.configurations.html +++ b/docs/dyn/run_v1.projects.locations.configurations.html @@ -376,7 +376,7 @@

Method Details

}, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. "secret": { # The secret's value will be presented as the content of a file whose name is defined in the item path. If no items are defined, the name of the file is the secret_name. The contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the file names. - "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 01 and 0777 (octal). If 0 or not set, it will default to 0644. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. + "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 01 and 0777 (octal). If 0 or not set, it will default to 0444. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. "items": [ # (Optional) If unspecified, the volume will expose a file whose name is the secret_name. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a key and a path. If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified that is not present in the Secret, the volume setup will error unless it is marked optional. { # Maps a string key to a path within a volume. "key": "A String", # The Cloud Secret Manager secret version. Can be 'latest' for the latest value or an integer for a specific version. The key to project. @@ -707,7 +707,7 @@

Method Details

}, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. "secret": { # The secret's value will be presented as the content of a file whose name is defined in the item path. If no items are defined, the name of the file is the secret_name. The contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the file names. - "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 01 and 0777 (octal). If 0 or not set, it will default to 0644. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. + "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 01 and 0777 (octal). If 0 or not set, it will default to 0444. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. "items": [ # (Optional) If unspecified, the volume will expose a file whose name is the secret_name. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a key and a path. If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified that is not present in the Secret, the volume setup will error unless it is marked optional. { # Maps a string key to a path within a volume. "key": "A String", # The Cloud Secret Manager secret version. Can be 'latest' for the latest value or an integer for a specific version. The key to project. diff --git a/docs/dyn/run_v1.projects.locations.revisions.html b/docs/dyn/run_v1.projects.locations.revisions.html index d9c04007286..275addbc680 100644 --- a/docs/dyn/run_v1.projects.locations.revisions.html +++ b/docs/dyn/run_v1.projects.locations.revisions.html @@ -390,7 +390,7 @@

Method Details

}, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. "secret": { # The secret's value will be presented as the content of a file whose name is defined in the item path. If no items are defined, the name of the file is the secret_name. The contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the file names. - "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 01 and 0777 (octal). If 0 or not set, it will default to 0644. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. + "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 01 and 0777 (octal). If 0 or not set, it will default to 0444. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. "items": [ # (Optional) If unspecified, the volume will expose a file whose name is the secret_name. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a key and a path. If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified that is not present in the Secret, the volume setup will error unless it is marked optional. { # Maps a string key to a path within a volume. "key": "A String", # The Cloud Secret Manager secret version. Can be 'latest' for the latest value or an integer for a specific version. The key to project. @@ -686,7 +686,7 @@

Method Details

}, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. "secret": { # The secret's value will be presented as the content of a file whose name is defined in the item path. If no items are defined, the name of the file is the secret_name. The contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the file names. - "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 01 and 0777 (octal). If 0 or not set, it will default to 0644. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. + "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 01 and 0777 (octal). If 0 or not set, it will default to 0444. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. "items": [ # (Optional) If unspecified, the volume will expose a file whose name is the secret_name. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a key and a path. If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified that is not present in the Secret, the volume setup will error unless it is marked optional. { # Maps a string key to a path within a volume. "key": "A String", # The Cloud Secret Manager secret version. Can be 'latest' for the latest value or an integer for a specific version. The key to project. diff --git a/docs/dyn/run_v1.projects.locations.services.html b/docs/dyn/run_v1.projects.locations.services.html index e82840bcb19..9f9ced5d5be 100644 --- a/docs/dyn/run_v1.projects.locations.services.html +++ b/docs/dyn/run_v1.projects.locations.services.html @@ -389,7 +389,7 @@

Method Details

}, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. "secret": { # The secret's value will be presented as the content of a file whose name is defined in the item path. If no items are defined, the name of the file is the secret_name. The contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the file names. - "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 01 and 0777 (octal). If 0 or not set, it will default to 0644. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. + "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 01 and 0777 (octal). If 0 or not set, it will default to 0444. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. "items": [ # (Optional) If unspecified, the volume will expose a file whose name is the secret_name. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a key and a path. If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified that is not present in the Secret, the volume setup will error unless it is marked optional. { # Maps a string key to a path within a volume. "key": "A String", # The Cloud Secret Manager secret version. Can be 'latest' for the latest value or an integer for a specific version. The key to project. @@ -728,7 +728,7 @@

Method Details

}, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. "secret": { # The secret's value will be presented as the content of a file whose name is defined in the item path. If no items are defined, the name of the file is the secret_name. The contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the file names. - "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 01 and 0777 (octal). If 0 or not set, it will default to 0644. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. + "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 01 and 0777 (octal). If 0 or not set, it will default to 0444. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. "items": [ # (Optional) If unspecified, the volume will expose a file whose name is the secret_name. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a key and a path. If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified that is not present in the Secret, the volume setup will error unless it is marked optional. { # Maps a string key to a path within a volume. "key": "A String", # The Cloud Secret Manager secret version. Can be 'latest' for the latest value or an integer for a specific version. The key to project. @@ -1118,7 +1118,7 @@

Method Details

}, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. "secret": { # The secret's value will be presented as the content of a file whose name is defined in the item path. If no items are defined, the name of the file is the secret_name. The contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the file names. - "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 01 and 0777 (octal). If 0 or not set, it will default to 0644. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. + "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 01 and 0777 (octal). If 0 or not set, it will default to 0444. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. "items": [ # (Optional) If unspecified, the volume will expose a file whose name is the secret_name. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a key and a path. If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified that is not present in the Secret, the volume setup will error unless it is marked optional. { # Maps a string key to a path within a volume. "key": "A String", # The Cloud Secret Manager secret version. Can be 'latest' for the latest value or an integer for a specific version. The key to project. @@ -1521,7 +1521,7 @@

Method Details

}, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. "secret": { # The secret's value will be presented as the content of a file whose name is defined in the item path. If no items are defined, the name of the file is the secret_name. The contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the file names. - "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 01 and 0777 (octal). If 0 or not set, it will default to 0644. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. + "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 01 and 0777 (octal). If 0 or not set, it will default to 0444. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. "items": [ # (Optional) If unspecified, the volume will expose a file whose name is the secret_name. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a key and a path. If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified that is not present in the Secret, the volume setup will error unless it is marked optional. { # Maps a string key to a path within a volume. "key": "A String", # The Cloud Secret Manager secret version. Can be 'latest' for the latest value or an integer for a specific version. The key to project. @@ -1872,7 +1872,7 @@

Method Details

}, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. "secret": { # The secret's value will be presented as the content of a file whose name is defined in the item path. If no items are defined, the name of the file is the secret_name. The contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the file names. - "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 01 and 0777 (octal). If 0 or not set, it will default to 0644. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. + "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 01 and 0777 (octal). If 0 or not set, it will default to 0444. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. "items": [ # (Optional) If unspecified, the volume will expose a file whose name is the secret_name. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a key and a path. If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified that is not present in the Secret, the volume setup will error unless it is marked optional. { # Maps a string key to a path within a volume. "key": "A String", # The Cloud Secret Manager secret version. Can be 'latest' for the latest value or an integer for a specific version. The key to project. @@ -2211,7 +2211,7 @@

Method Details

}, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. "secret": { # The secret's value will be presented as the content of a file whose name is defined in the item path. If no items are defined, the name of the file is the secret_name. The contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the file names. - "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 01 and 0777 (octal). If 0 or not set, it will default to 0644. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. + "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 01 and 0777 (octal). If 0 or not set, it will default to 0444. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. "items": [ # (Optional) If unspecified, the volume will expose a file whose name is the secret_name. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a key and a path. If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified that is not present in the Secret, the volume setup will error unless it is marked optional. { # Maps a string key to a path within a volume. "key": "A String", # The Cloud Secret Manager secret version. Can be 'latest' for the latest value or an integer for a specific version. The key to project. diff --git a/docs/dyn/run_v1alpha1.namespaces.jobs.html b/docs/dyn/run_v1alpha1.namespaces.jobs.html index e35be736f6a..0a6e4f59ace 100644 --- a/docs/dyn/run_v1alpha1.namespaces.jobs.html +++ b/docs/dyn/run_v1alpha1.namespaces.jobs.html @@ -344,7 +344,7 @@

Method Details

}, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. "secret": { # The secret's value will be presented as the content of a file whose name is defined in the item path. If no items are defined, the name of the file is the secret_name. The contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the file names. - "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 01 and 0777 (octal). If 0 or not set, it will default to 0644. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. + "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 01 and 0777 (octal). If 0 or not set, it will default to 0444. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. "items": [ # (Optional) If unspecified, the volume will expose a file whose name is the secret_name. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a key and a path. If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified that is not present in the Secret, the volume setup will error unless it is marked optional. { # Maps a string key to a path within a volume. "key": "A String", # The Cloud Secret Manager secret version. Can be 'latest' for the latest value or an integer for a specific version. The key to project. @@ -653,7 +653,7 @@

Method Details

}, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. "secret": { # The secret's value will be presented as the content of a file whose name is defined in the item path. If no items are defined, the name of the file is the secret_name. The contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the file names. - "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 01 and 0777 (octal). If 0 or not set, it will default to 0644. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. + "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 01 and 0777 (octal). If 0 or not set, it will default to 0444. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. "items": [ # (Optional) If unspecified, the volume will expose a file whose name is the secret_name. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a key and a path. If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified that is not present in the Secret, the volume setup will error unless it is marked optional. { # Maps a string key to a path within a volume. "key": "A String", # The Cloud Secret Manager secret version. Can be 'latest' for the latest value or an integer for a specific version. The key to project. @@ -990,7 +990,7 @@

Method Details

}, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. "secret": { # The secret's value will be presented as the content of a file whose name is defined in the item path. If no items are defined, the name of the file is the secret_name. The contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the file names. - "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 01 and 0777 (octal). If 0 or not set, it will default to 0644. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. + "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 01 and 0777 (octal). If 0 or not set, it will default to 0444. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. "items": [ # (Optional) If unspecified, the volume will expose a file whose name is the secret_name. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a key and a path. If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified that is not present in the Secret, the volume setup will error unless it is marked optional. { # Maps a string key to a path within a volume. "key": "A String", # The Cloud Secret Manager secret version. Can be 'latest' for the latest value or an integer for a specific version. The key to project. @@ -1316,7 +1316,7 @@

Method Details

}, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. "secret": { # The secret's value will be presented as the content of a file whose name is defined in the item path. If no items are defined, the name of the file is the secret_name. The contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the file names. - "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 01 and 0777 (octal). If 0 or not set, it will default to 0644. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. + "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 01 and 0777 (octal). If 0 or not set, it will default to 0444. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. "items": [ # (Optional) If unspecified, the volume will expose a file whose name is the secret_name. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a key and a path. If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified that is not present in the Secret, the volume setup will error unless it is marked optional. { # Maps a string key to a path within a volume. "key": "A String", # The Cloud Secret Manager secret version. Can be 'latest' for the latest value or an integer for a specific version. The key to project. diff --git a/docs/dyn/run_v2.projects.locations.jobs.executions.html b/docs/dyn/run_v2.projects.locations.jobs.executions.html index 71263745db4..019f6c59a55 100644 --- a/docs/dyn/run_v2.projects.locations.jobs.executions.html +++ b/docs/dyn/run_v2.projects.locations.jobs.executions.html @@ -228,6 +228,7 @@

Method Details

"name": "A String", # Required. This must match the Name of a Volume. }, ], + "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. }, ], "encryptionKey": "A String", # A reference to a customer managed encryption key (CMEK) to use to encrypt this container image. For more information, go to https://cloud.google.com/run/docs/securing/using-cmek @@ -244,7 +245,7 @@

Method Details

}, "name": "A String", # Required. Volume's name. "secret": { # The secret's value will be presented as the content of a file whose name is defined in the item path. If no items are defined, the name of the file is the secret. # Secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret - "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 0000 and 0777 (octal), defaulting to 0644. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. This might be in conflict with other options that affect the file mode, like fsGroup, and as a result, other mode bits could be set. + "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 0000 and 0777 (octal), defaulting to 0444. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. This might be in conflict with other options that affect the file mode, like fsGroup, and as a result, other mode bits could be set. "items": [ # If unspecified, the volume will expose a file whose name is the secret, relative to VolumeMount.mount_path. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a path and a version. { # VersionToPath maps a specific version of a secret to a relative file to mount to, relative to VolumeMount's mount_path. "mode": 42, # Integer octal mode bits to use on this file, must be a value between 01 and 0777 (octal). If 0 or not set, the Volume's default mode will be used. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. @@ -362,6 +363,7 @@

Method Details

"name": "A String", # Required. This must match the Name of a Volume. }, ], + "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. }, ], "encryptionKey": "A String", # A reference to a customer managed encryption key (CMEK) to use to encrypt this container image. For more information, go to https://cloud.google.com/run/docs/securing/using-cmek @@ -378,7 +380,7 @@

Method Details

}, "name": "A String", # Required. Volume's name. "secret": { # The secret's value will be presented as the content of a file whose name is defined in the item path. If no items are defined, the name of the file is the secret. # Secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret - "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 0000 and 0777 (octal), defaulting to 0644. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. This might be in conflict with other options that affect the file mode, like fsGroup, and as a result, other mode bits could be set. + "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 0000 and 0777 (octal), defaulting to 0444. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. This might be in conflict with other options that affect the file mode, like fsGroup, and as a result, other mode bits could be set. "items": [ # If unspecified, the volume will expose a file whose name is the secret, relative to VolumeMount.mount_path. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a path and a version. { # VersionToPath maps a specific version of a secret to a relative file to mount to, relative to VolumeMount's mount_path. "mode": 42, # Integer octal mode bits to use on this file, must be a value between 01 and 0777 (octal). If 0 or not set, the Volume's default mode will be used. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. diff --git a/docs/dyn/run_v2.projects.locations.jobs.executions.tasks.html b/docs/dyn/run_v2.projects.locations.jobs.executions.tasks.html index 6e0d55de235..33981949182 100644 --- a/docs/dyn/run_v2.projects.locations.jobs.executions.tasks.html +++ b/docs/dyn/run_v2.projects.locations.jobs.executions.tasks.html @@ -163,6 +163,7 @@

Method Details

"name": "A String", # Required. This must match the Name of a Volume. }, ], + "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. }, ], "createTime": "A String", # Output only. Represents time when the task was created by the job controller. It is not guaranteed to be set in happens-before order across separate operations. @@ -210,7 +211,7 @@

Method Details

}, "name": "A String", # Required. Volume's name. "secret": { # The secret's value will be presented as the content of a file whose name is defined in the item path. If no items are defined, the name of the file is the secret. # Secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret - "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 0000 and 0777 (octal), defaulting to 0644. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. This might be in conflict with other options that affect the file mode, like fsGroup, and as a result, other mode bits could be set. + "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 0000 and 0777 (octal), defaulting to 0444. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. This might be in conflict with other options that affect the file mode, like fsGroup, and as a result, other mode bits could be set. "items": [ # If unspecified, the volume will expose a file whose name is the secret, relative to VolumeMount.mount_path. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a path and a version. { # VersionToPath maps a specific version of a secret to a relative file to mount to, relative to VolumeMount's mount_path. "mode": 42, # Integer octal mode bits to use on this file, must be a value between 01 and 0777 (octal). If 0 or not set, the Volume's default mode will be used. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. @@ -306,6 +307,7 @@

Method Details

"name": "A String", # Required. This must match the Name of a Volume. }, ], + "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. }, ], "createTime": "A String", # Output only. Represents time when the task was created by the job controller. It is not guaranteed to be set in happens-before order across separate operations. @@ -353,7 +355,7 @@

Method Details

}, "name": "A String", # Required. Volume's name. "secret": { # The secret's value will be presented as the content of a file whose name is defined in the item path. If no items are defined, the name of the file is the secret. # Secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret - "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 0000 and 0777 (octal), defaulting to 0644. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. This might be in conflict with other options that affect the file mode, like fsGroup, and as a result, other mode bits could be set. + "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 0000 and 0777 (octal), defaulting to 0444. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. This might be in conflict with other options that affect the file mode, like fsGroup, and as a result, other mode bits could be set. "items": [ # If unspecified, the volume will expose a file whose name is the secret, relative to VolumeMount.mount_path. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a path and a version. { # VersionToPath maps a specific version of a secret to a relative file to mount to, relative to VolumeMount's mount_path. "mode": 42, # Integer octal mode bits to use on this file, must be a value between 01 and 0777 (octal). If 0 or not set, the Volume's default mode will be used. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. diff --git a/docs/dyn/run_v2.projects.locations.jobs.html b/docs/dyn/run_v2.projects.locations.jobs.html index 7851c7813f2..5f7df869548 100644 --- a/docs/dyn/run_v2.projects.locations.jobs.html +++ b/docs/dyn/run_v2.projects.locations.jobs.html @@ -219,6 +219,7 @@

Method Details

"name": "A String", # Required. This must match the Name of a Volume. }, ], + "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. }, ], "encryptionKey": "A String", # A reference to a customer managed encryption key (CMEK) to use to encrypt this container image. For more information, go to https://cloud.google.com/run/docs/securing/using-cmek @@ -235,7 +236,7 @@

Method Details

}, "name": "A String", # Required. Volume's name. "secret": { # The secret's value will be presented as the content of a file whose name is defined in the item path. If no items are defined, the name of the file is the secret. # Secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret - "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 0000 and 0777 (octal), defaulting to 0644. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. This might be in conflict with other options that affect the file mode, like fsGroup, and as a result, other mode bits could be set. + "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 0000 and 0777 (octal), defaulting to 0444. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. This might be in conflict with other options that affect the file mode, like fsGroup, and as a result, other mode bits could be set. "items": [ # If unspecified, the volume will expose a file whose name is the secret, relative to VolumeMount.mount_path. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a path and a version. { # VersionToPath maps a specific version of a secret to a relative file to mount to, relative to VolumeMount's mount_path. "mode": 42, # Integer octal mode bits to use on this file, must be a value between 01 and 0777 (octal). If 0 or not set, the Volume's default mode will be used. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. @@ -442,6 +443,7 @@

Method Details

"name": "A String", # Required. This must match the Name of a Volume. }, ], + "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. }, ], "encryptionKey": "A String", # A reference to a customer managed encryption key (CMEK) to use to encrypt this container image. For more information, go to https://cloud.google.com/run/docs/securing/using-cmek @@ -458,7 +460,7 @@

Method Details

}, "name": "A String", # Required. Volume's name. "secret": { # The secret's value will be presented as the content of a file whose name is defined in the item path. If no items are defined, the name of the file is the secret. # Secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret - "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 0000 and 0777 (octal), defaulting to 0644. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. This might be in conflict with other options that affect the file mode, like fsGroup, and as a result, other mode bits could be set. + "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 0000 and 0777 (octal), defaulting to 0444. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. This might be in conflict with other options that affect the file mode, like fsGroup, and as a result, other mode bits could be set. "items": [ # If unspecified, the volume will expose a file whose name is the secret, relative to VolumeMount.mount_path. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a path and a version. { # VersionToPath maps a specific version of a secret to a relative file to mount to, relative to VolumeMount's mount_path. "mode": 42, # Integer octal mode bits to use on this file, must be a value between 01 and 0777 (octal). If 0 or not set, the Volume's default mode will be used. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. @@ -650,6 +652,7 @@

Method Details

"name": "A String", # Required. This must match the Name of a Volume. }, ], + "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. }, ], "encryptionKey": "A String", # A reference to a customer managed encryption key (CMEK) to use to encrypt this container image. For more information, go to https://cloud.google.com/run/docs/securing/using-cmek @@ -666,7 +669,7 @@

Method Details

}, "name": "A String", # Required. Volume's name. "secret": { # The secret's value will be presented as the content of a file whose name is defined in the item path. If no items are defined, the name of the file is the secret. # Secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret - "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 0000 and 0777 (octal), defaulting to 0644. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. This might be in conflict with other options that affect the file mode, like fsGroup, and as a result, other mode bits could be set. + "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 0000 and 0777 (octal), defaulting to 0444. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. This might be in conflict with other options that affect the file mode, like fsGroup, and as a result, other mode bits could be set. "items": [ # If unspecified, the volume will expose a file whose name is the secret, relative to VolumeMount.mount_path. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a path and a version. { # VersionToPath maps a specific version of a secret to a relative file to mount to, relative to VolumeMount's mount_path. "mode": 42, # Integer octal mode bits to use on this file, must be a value between 01 and 0777 (octal). If 0 or not set, the Volume's default mode will be used. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. @@ -817,6 +820,7 @@

Method Details

"name": "A String", # Required. This must match the Name of a Volume. }, ], + "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. }, ], "encryptionKey": "A String", # A reference to a customer managed encryption key (CMEK) to use to encrypt this container image. For more information, go to https://cloud.google.com/run/docs/securing/using-cmek @@ -833,7 +837,7 @@

Method Details

}, "name": "A String", # Required. Volume's name. "secret": { # The secret's value will be presented as the content of a file whose name is defined in the item path. If no items are defined, the name of the file is the secret. # Secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret - "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 0000 and 0777 (octal), defaulting to 0644. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. This might be in conflict with other options that affect the file mode, like fsGroup, and as a result, other mode bits could be set. + "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 0000 and 0777 (octal), defaulting to 0444. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. This might be in conflict with other options that affect the file mode, like fsGroup, and as a result, other mode bits could be set. "items": [ # If unspecified, the volume will expose a file whose name is the secret, relative to VolumeMount.mount_path. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a path and a version. { # VersionToPath maps a specific version of a secret to a relative file to mount to, relative to VolumeMount's mount_path. "mode": 42, # Integer octal mode bits to use on this file, must be a value between 01 and 0777 (octal). If 0 or not set, the Volume's default mode will be used. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. diff --git a/docs/dyn/run_v2.projects.locations.services.html b/docs/dyn/run_v2.projects.locations.services.html index ed1acb54484..a3c1a1173b4 100644 --- a/docs/dyn/run_v2.projects.locations.services.html +++ b/docs/dyn/run_v2.projects.locations.services.html @@ -208,6 +208,7 @@

Method Details

"name": "A String", # Required. This must match the Name of a Volume. }, ], + "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. }, ], "encryptionKey": "A String", # A reference to a customer managed encryption key (CMEK) to use to encrypt this container image. For more information, go to https://cloud.google.com/run/docs/securing/using-cmek @@ -232,7 +233,7 @@

Method Details

}, "name": "A String", # Required. Volume's name. "secret": { # The secret's value will be presented as the content of a file whose name is defined in the item path. If no items are defined, the name of the file is the secret. # Secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret - "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 0000 and 0777 (octal), defaulting to 0644. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. This might be in conflict with other options that affect the file mode, like fsGroup, and as a result, other mode bits could be set. + "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 0000 and 0777 (octal), defaulting to 0444. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. This might be in conflict with other options that affect the file mode, like fsGroup, and as a result, other mode bits could be set. "items": [ # If unspecified, the volume will expose a file whose name is the secret, relative to VolumeMount.mount_path. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a path and a version. { # VersionToPath maps a specific version of a secret to a relative file to mount to, relative to VolumeMount's mount_path. "mode": 42, # Integer octal mode bits to use on this file, must be a value between 01 and 0777 (octal). If 0 or not set, the Volume's default mode will be used. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. @@ -447,6 +448,7 @@

Method Details

"name": "A String", # Required. This must match the Name of a Volume. }, ], + "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. }, ], "encryptionKey": "A String", # A reference to a customer managed encryption key (CMEK) to use to encrypt this container image. For more information, go to https://cloud.google.com/run/docs/securing/using-cmek @@ -471,7 +473,7 @@

Method Details

}, "name": "A String", # Required. Volume's name. "secret": { # The secret's value will be presented as the content of a file whose name is defined in the item path. If no items are defined, the name of the file is the secret. # Secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret - "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 0000 and 0777 (octal), defaulting to 0644. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. This might be in conflict with other options that affect the file mode, like fsGroup, and as a result, other mode bits could be set. + "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 0000 and 0777 (octal), defaulting to 0444. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. This might be in conflict with other options that affect the file mode, like fsGroup, and as a result, other mode bits could be set. "items": [ # If unspecified, the volume will expose a file whose name is the secret, relative to VolumeMount.mount_path. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a path and a version. { # VersionToPath maps a specific version of a secret to a relative file to mount to, relative to VolumeMount's mount_path. "mode": 42, # Integer octal mode bits to use on this file, must be a value between 01 and 0777 (octal). If 0 or not set, the Volume's default mode will be used. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. @@ -673,6 +675,7 @@

Method Details

"name": "A String", # Required. This must match the Name of a Volume. }, ], + "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. }, ], "encryptionKey": "A String", # A reference to a customer managed encryption key (CMEK) to use to encrypt this container image. For more information, go to https://cloud.google.com/run/docs/securing/using-cmek @@ -697,7 +700,7 @@

Method Details

}, "name": "A String", # Required. Volume's name. "secret": { # The secret's value will be presented as the content of a file whose name is defined in the item path. If no items are defined, the name of the file is the secret. # Secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret - "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 0000 and 0777 (octal), defaulting to 0644. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. This might be in conflict with other options that affect the file mode, like fsGroup, and as a result, other mode bits could be set. + "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 0000 and 0777 (octal), defaulting to 0444. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. This might be in conflict with other options that affect the file mode, like fsGroup, and as a result, other mode bits could be set. "items": [ # If unspecified, the volume will expose a file whose name is the secret, relative to VolumeMount.mount_path. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a path and a version. { # VersionToPath maps a specific version of a secret to a relative file to mount to, relative to VolumeMount's mount_path. "mode": 42, # Integer octal mode bits to use on this file, must be a value between 01 and 0777 (octal). If 0 or not set, the Volume's default mode will be used. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. @@ -856,6 +859,7 @@

Method Details

"name": "A String", # Required. This must match the Name of a Volume. }, ], + "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. }, ], "encryptionKey": "A String", # A reference to a customer managed encryption key (CMEK) to use to encrypt this container image. For more information, go to https://cloud.google.com/run/docs/securing/using-cmek @@ -880,7 +884,7 @@

Method Details

}, "name": "A String", # Required. Volume's name. "secret": { # The secret's value will be presented as the content of a file whose name is defined in the item path. If no items are defined, the name of the file is the secret. # Secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret - "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 0000 and 0777 (octal), defaulting to 0644. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. This might be in conflict with other options that affect the file mode, like fsGroup, and as a result, other mode bits could be set. + "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 0000 and 0777 (octal), defaulting to 0444. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. This might be in conflict with other options that affect the file mode, like fsGroup, and as a result, other mode bits could be set. "items": [ # If unspecified, the volume will expose a file whose name is the secret, relative to VolumeMount.mount_path. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a path and a version. { # VersionToPath maps a specific version of a secret to a relative file to mount to, relative to VolumeMount's mount_path. "mode": 42, # Integer octal mode bits to use on this file, must be a value between 01 and 0777 (octal). If 0 or not set, the Volume's default mode will be used. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. diff --git a/docs/dyn/run_v2.projects.locations.services.revisions.html b/docs/dyn/run_v2.projects.locations.services.revisions.html index 299d283f897..9b859a6d8a4 100644 --- a/docs/dyn/run_v2.projects.locations.services.revisions.html +++ b/docs/dyn/run_v2.projects.locations.services.revisions.html @@ -202,6 +202,7 @@

Method Details

"name": "A String", # Required. This must match the Name of a Volume. }, ], + "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. }, ], "createTime": "A String", # Output only. The creation time. @@ -238,7 +239,7 @@

Method Details

}, "name": "A String", # Required. Volume's name. "secret": { # The secret's value will be presented as the content of a file whose name is defined in the item path. If no items are defined, the name of the file is the secret. # Secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret - "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 0000 and 0777 (octal), defaulting to 0644. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. This might be in conflict with other options that affect the file mode, like fsGroup, and as a result, other mode bits could be set. + "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 0000 and 0777 (octal), defaulting to 0444. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. This might be in conflict with other options that affect the file mode, like fsGroup, and as a result, other mode bits could be set. "items": [ # If unspecified, the volume will expose a file whose name is the secret, relative to VolumeMount.mount_path. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a path and a version. { # VersionToPath maps a specific version of a secret to a relative file to mount to, relative to VolumeMount's mount_path. "mode": 42, # Integer octal mode bits to use on this file, must be a value between 01 and 0777 (octal). If 0 or not set, the Volume's default mode will be used. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. @@ -333,6 +334,7 @@

Method Details

"name": "A String", # Required. This must match the Name of a Volume. }, ], + "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. }, ], "createTime": "A String", # Output only. The creation time. @@ -369,7 +371,7 @@

Method Details

}, "name": "A String", # Required. Volume's name. "secret": { # The secret's value will be presented as the content of a file whose name is defined in the item path. If no items are defined, the name of the file is the secret. # Secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret - "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 0000 and 0777 (octal), defaulting to 0644. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. This might be in conflict with other options that affect the file mode, like fsGroup, and as a result, other mode bits could be set. + "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 0000 and 0777 (octal), defaulting to 0444. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. This might be in conflict with other options that affect the file mode, like fsGroup, and as a result, other mode bits could be set. "items": [ # If unspecified, the volume will expose a file whose name is the secret, relative to VolumeMount.mount_path. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a path and a version. { # VersionToPath maps a specific version of a secret to a relative file to mount to, relative to VolumeMount's mount_path. "mode": 42, # Integer octal mode bits to use on this file, must be a value between 01 and 0777 (octal). If 0 or not set, the Volume's default mode will be used. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. diff --git a/googleapiclient/discovery_cache/documents/run.v1.json b/googleapiclient/discovery_cache/documents/run.v1.json index 6fc1485ef99..2a0222341ea 100644 --- a/googleapiclient/discovery_cache/documents/run.v1.json +++ b/googleapiclient/discovery_cache/documents/run.v1.json @@ -2261,7 +2261,7 @@ } } }, - "revision": "20220626", + "revision": "20220710", "rootUrl": "https://run.googleapis.com/", "schemas": { "Addressable": { @@ -3986,7 +3986,7 @@ "id": "SecretVolumeSource", "properties": { "defaultMode": { - "description": "Integer representation of mode bits to use on created files by default. Must be a value between 01 and 0777 (octal). If 0 or not set, it will default to 0644. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.", + "description": "Integer representation of mode bits to use on created files by default. Must be a value between 01 and 0777 (octal). If 0 or not set, it will default to 0444. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.", "format": "int32", "type": "integer" }, diff --git a/googleapiclient/discovery_cache/documents/run.v1alpha1.json b/googleapiclient/discovery_cache/documents/run.v1alpha1.json index b378e4b57a6..9e9119bdd37 100644 --- a/googleapiclient/discovery_cache/documents/run.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/run.v1alpha1.json @@ -268,7 +268,7 @@ } } }, - "revision": "20220626", + "revision": "20220710", "rootUrl": "https://run.googleapis.com/", "schemas": { "ConfigMapEnvSource": { @@ -1188,7 +1188,7 @@ "id": "SecretVolumeSource", "properties": { "defaultMode": { - "description": "Integer representation of mode bits to use on created files by default. Must be a value between 01 and 0777 (octal). If 0 or not set, it will default to 0644. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.", + "description": "Integer representation of mode bits to use on created files by default. Must be a value between 01 and 0777 (octal). If 0 or not set, it will default to 0444. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.", "format": "int32", "type": "integer" }, diff --git a/googleapiclient/discovery_cache/documents/run.v2.json b/googleapiclient/discovery_cache/documents/run.v2.json index f3bb9739e6f..0707a88e3e1 100644 --- a/googleapiclient/discovery_cache/documents/run.v2.json +++ b/googleapiclient/discovery_cache/documents/run.v2.json @@ -1064,7 +1064,7 @@ } } }, - "revision": "20220626", + "revision": "20220710", "rootUrl": "https://run.googleapis.com/", "schemas": { "GoogleCloudRunV2BinaryAuthorization": { @@ -1105,12 +1105,14 @@ "enum": [ "EXECUTION_REASON_UNDEFINED", "JOB_STATUS_SERVICE_POLLING_ERROR", - "NON_ZERO_EXIT_CODE" + "NON_ZERO_EXIT_CODE", + "CANCELLED" ], "enumDescriptions": [ "Default value.", "Internal system error getting execution status. System will retry.", - "A task reached its retry limit and the last attempt failed due to the user container exiting with a non-zero exit code." + "A task reached its retry limit and the last attempt failed due to the user container exiting with a non-zero exit code.", + "The execution was cancelled by users." ], "type": "string" }, @@ -1284,6 +1286,10 @@ "$ref": "GoogleCloudRunV2VolumeMount" }, "type": "array" + }, + "workingDir": { + "description": "Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image.", + "type": "string" } }, "type": "object" @@ -2113,7 +2119,7 @@ "id": "GoogleCloudRunV2SecretVolumeSource", "properties": { "defaultMode": { - "description": "Integer representation of mode bits to use on created files by default. Must be a value between 0000 and 0777 (octal), defaulting to 0644. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. This might be in conflict with other options that affect the file mode, like fsGroup, and as a result, other mode bits could be set.", + "description": "Integer representation of mode bits to use on created files by default. Must be a value between 0000 and 0777 (octal), defaulting to 0444. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. This might be in conflict with other options that affect the file mode, like fsGroup, and as a result, other mode bits could be set.", "format": "int32", "type": "integer" }, From 9c5ed43310c474937f68e9911aac8f665cc2521b Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 19 Jul 2022 07:08:15 +0000 Subject: [PATCH 20/23] feat(securitycenter): update the api #### securitycenter:v1 The following keys were added: - schemas.AccessReview (Total Keys: 9) - schemas.Container (Total Keys: 7) - schemas.Finding.properties.containers (Total Keys: 2) - schemas.Finding.properties.kubernetes.$ref (Total Keys: 1) - schemas.GoogleCloudSecuritycenterV1Binding (Total Keys: 7) - schemas.Kubernetes (Total Keys: 14) - schemas.Label (Total Keys: 4) - schemas.Node (Total Keys: 8) - schemas.Pod (Total Keys: 8) - schemas.Role (Total Keys: 5) - schemas.Subject (Total Keys: 5) #### securitycenter:v1beta1 The following keys were added: - schemas.AccessReview (Total Keys: 9) - schemas.Container (Total Keys: 7) - schemas.Finding.properties.containers (Total Keys: 2) - schemas.Finding.properties.kubernetes.$ref (Total Keys: 1) - schemas.GoogleCloudSecuritycenterV1Binding (Total Keys: 7) - schemas.Kubernetes (Total Keys: 14) - schemas.Label (Total Keys: 4) - schemas.Node (Total Keys: 8) - schemas.Pod (Total Keys: 8) - schemas.Role (Total Keys: 5) - schemas.Subject (Total Keys: 5) #### securitycenter:v1beta2 The following keys were added: - schemas.AccessReview (Total Keys: 9) - schemas.Container (Total Keys: 7) - schemas.Finding.properties.containers (Total Keys: 2) - schemas.Finding.properties.kubernetes.$ref (Total Keys: 1) - schemas.GoogleCloudSecuritycenterV1Binding (Total Keys: 7) - schemas.Kubernetes (Total Keys: 14) - schemas.Label (Total Keys: 4) - schemas.Node (Total Keys: 8) - schemas.Pod (Total Keys: 8) - schemas.Role (Total Keys: 5) - schemas.SecurityCenterSettings.properties.onboardingTime.readOnly (Total Keys: 1) - schemas.SecurityCenterSettings.properties.orgServiceAccount.readOnly (Total Keys: 1) - schemas.Subject (Total Keys: 5) --- ...itycenter_v1.folders.sources.findings.html | 465 ++++++++++++- ...ter_v1.organizations.sources.findings.html | 651 +++++++++++++++++- ...tycenter_v1.projects.sources.findings.html | 465 ++++++++++++- docs/dyn/securitycenter_v1beta2.folders.html | 6 +- .../securitycenter_v1beta2.organizations.html | 6 +- docs/dyn/securitycenter_v1beta2.projects.html | 6 +- .../documents/securitycenter.v1.json | 296 +++++++- .../documents/securitycenter.v1beta1.json | 296 +++++++- .../documents/securitycenter.v1beta2.json | 304 +++++++- 9 files changed, 2448 insertions(+), 47 deletions(-) diff --git a/docs/dyn/securitycenter_v1.folders.sources.findings.html b/docs/dyn/securitycenter_v1.folders.sources.findings.html index 019365023c0..1dac89c7efe 100644 --- a/docs/dyn/securitycenter_v1.folders.sources.findings.html +++ b/docs/dyn/securitycenter_v1.folders.sources.findings.html @@ -222,7 +222,7 @@

Method Details

"sourcePort": 42, # Source port. }, ], - "contacts": { # Output only. Map containing the point of contacts for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { "security":[ { "contact":{ "email":"person1@company.com" } }, { "contact":{ "email":“person2@company.com” } } ] } + "contacts": { # Output only. Map containing the point of contacts for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { "security": { "contacts": [ { "email": "person1@company.com" }, { "email": "person2@company.com" } ] } "a_key": { # The details pertaining to specific contacts "contacts": [ # A list of contacts { # Representa a single contact's email address @@ -231,6 +231,19 @@

Method Details

], }, }, + "containers": [ # Containers associated with the finding. containers provides information for both Kubernetes and non-Kubernetes containers. + { # Container associated with the finding. + "imageId": "A String", # Optional container image id, when provided by the container runtime. Uniquely identifies the container image launched using a container image digest. + "labels": [ # Container labels, as provided by the container runtime. + { # Label represents a generic name=value label. Label has separate name and value fields to support filtering with contains(). + "name": "A String", # Label name. + "value": "A String", # Label value. + }, + ], + "name": "A String", # Container name. + "uri": "A String", # Container image URI provided when configuring a pod/container. May identify a container image version using mutable tags. + }, + ], "createTime": "A String", # The time at which the finding was created in Security Command Center. "description": "A String", # Contains more detail about the finding. "eventTime": "A String", # The time the finding was first detected. If an existing finding is updated, then this is the time the update occurred. For example, if the finding represents an open firewall, this property captures the time the detector believes the firewall became open. The accuracy is determined by the detector. If the finding is later resolved, then this time reflects when the finding was resolved. This must not be set to a value greater than the current timestamp. @@ -296,6 +309,84 @@

Method Details

}, ], }, + "kubernetes": { # Kubernetes related attributes. # Kubernetes resources associated with the finding. + "accessReviews": [ # Provides information on any Kubernetes access reviews (i.e. privilege checks) relevant to the finding. + { # Conveys information about a Kubernetes access review (e.g. kubectl auth can-i ...) that was involved in a finding. + "group": "A String", # Group is the API Group of the Resource. "*" means all. + "name": "A String", # Name is the name of the resource being requested. Empty means all. + "ns": "A String", # Namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces. Both are represented by "" (empty). + "resource": "A String", # Resource is the optional resource type requested. "*" means all. + "subresource": "A String", # Subresource is the optional subresource type. + "verb": "A String", # Verb is a Kubernetes resource API verb, like: get, list, watch, create, update, delete, proxy. "*" means all. + "version": "A String", # Version is the API Version of the Resource. "*" means all. + }, + ], + "bindings": [ # Provides Kubernetes role binding information for findings that involve RoleBindings or ClusterRoleBindings. + { # Represents a Kubernetes RoleBinding or ClusterRoleBinding. + "name": "A String", # Name for binding. + "ns": "A String", # Namespace for binding. + "role": { # Kubernetes Role or ClusterRole. # The Role or ClusterRole referenced by the binding. + "kind": "A String", # Role type. + "name": "A String", # Role name. + "ns": "A String", # Role namespace. + }, + "subjects": [ # Represents the subjects(s) bound to the role. Not always available for PATCH requests. + { # Represents a Kubernetes Subject. + "kind": "A String", # Authentication type for subject. + "name": "A String", # Name for subject. + "ns": "A String", # Namespace for subject. + }, + ], + }, + ], + "nodePools": [ # GKE Node Pools associated with the finding. This field will contain NodePool information for each Node, when it is available. + { # Provides GKE Node Pool information. + "name": "A String", # Kubernetes Node pool name. + "nodes": [ # Nodes associated with the finding. + { # Kubernetes Nodes associated with the finding. + "name": "A String", # Full Resource name of the Compute Engine VM running the cluster node. + }, + ], + }, + ], + "nodes": [ # Provides Kubernetes Node information. + { # Kubernetes Nodes associated with the finding. + "name": "A String", # Full Resource name of the Compute Engine VM running the cluster node. + }, + ], + "pods": [ # Kubernetes Pods associated with the finding. This field will contain Pod records for each container that is owned by a Pod. + { # Kubernetes Pod. + "containers": [ # Pod containers associated with this finding, if any. + { # Container associated with the finding. + "imageId": "A String", # Optional container image id, when provided by the container runtime. Uniquely identifies the container image launched using a container image digest. + "labels": [ # Container labels, as provided by the container runtime. + { # Label represents a generic name=value label. Label has separate name and value fields to support filtering with contains(). + "name": "A String", # Label name. + "value": "A String", # Label value. + }, + ], + "name": "A String", # Container name. + "uri": "A String", # Container image URI provided when configuring a pod/container. May identify a container image version using mutable tags. + }, + ], + "labels": [ # Pod labels. For Kubernetes containers, these are applied to the container. + { # Label represents a generic name=value label. Label has separate name and value fields to support filtering with contains(). + "name": "A String", # Label name. + "value": "A String", # Label value. + }, + ], + "name": "A String", # Kubernetes Pod name. + "ns": "A String", # Kubernetes Pod namespace. + }, + ], + "roles": [ # Provides Kubernetes role information for findings that involve Roles or ClusterRoles. + { # Kubernetes Role or ClusterRole. + "kind": "A String", # Role type. + "name": "A String", # Role name. + "ns": "A String", # Role namespace. + }, + ], + }, "mitreAttack": { # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org "additionalTactics": [ # Additional MITRE ATT&CK tactics related to this finding, if any. "A String", @@ -474,7 +565,7 @@

Method Details

"sourcePort": 42, # Source port. }, ], - "contacts": { # Output only. Map containing the point of contacts for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { "security":[ { "contact":{ "email":"person1@company.com" } }, { "contact":{ "email":“person2@company.com” } } ] } + "contacts": { # Output only. Map containing the point of contacts for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { "security": { "contacts": [ { "email": "person1@company.com" }, { "email": "person2@company.com" } ] } "a_key": { # The details pertaining to specific contacts "contacts": [ # A list of contacts { # Representa a single contact's email address @@ -483,6 +574,19 @@

Method Details

], }, }, + "containers": [ # Containers associated with the finding. containers provides information for both Kubernetes and non-Kubernetes containers. + { # Container associated with the finding. + "imageId": "A String", # Optional container image id, when provided by the container runtime. Uniquely identifies the container image launched using a container image digest. + "labels": [ # Container labels, as provided by the container runtime. + { # Label represents a generic name=value label. Label has separate name and value fields to support filtering with contains(). + "name": "A String", # Label name. + "value": "A String", # Label value. + }, + ], + "name": "A String", # Container name. + "uri": "A String", # Container image URI provided when configuring a pod/container. May identify a container image version using mutable tags. + }, + ], "createTime": "A String", # The time at which the finding was created in Security Command Center. "description": "A String", # Contains more detail about the finding. "eventTime": "A String", # The time the finding was first detected. If an existing finding is updated, then this is the time the update occurred. For example, if the finding represents an open firewall, this property captures the time the detector believes the firewall became open. The accuracy is determined by the detector. If the finding is later resolved, then this time reflects when the finding was resolved. This must not be set to a value greater than the current timestamp. @@ -548,6 +652,84 @@

Method Details

}, ], }, + "kubernetes": { # Kubernetes related attributes. # Kubernetes resources associated with the finding. + "accessReviews": [ # Provides information on any Kubernetes access reviews (i.e. privilege checks) relevant to the finding. + { # Conveys information about a Kubernetes access review (e.g. kubectl auth can-i ...) that was involved in a finding. + "group": "A String", # Group is the API Group of the Resource. "*" means all. + "name": "A String", # Name is the name of the resource being requested. Empty means all. + "ns": "A String", # Namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces. Both are represented by "" (empty). + "resource": "A String", # Resource is the optional resource type requested. "*" means all. + "subresource": "A String", # Subresource is the optional subresource type. + "verb": "A String", # Verb is a Kubernetes resource API verb, like: get, list, watch, create, update, delete, proxy. "*" means all. + "version": "A String", # Version is the API Version of the Resource. "*" means all. + }, + ], + "bindings": [ # Provides Kubernetes role binding information for findings that involve RoleBindings or ClusterRoleBindings. + { # Represents a Kubernetes RoleBinding or ClusterRoleBinding. + "name": "A String", # Name for binding. + "ns": "A String", # Namespace for binding. + "role": { # Kubernetes Role or ClusterRole. # The Role or ClusterRole referenced by the binding. + "kind": "A String", # Role type. + "name": "A String", # Role name. + "ns": "A String", # Role namespace. + }, + "subjects": [ # Represents the subjects(s) bound to the role. Not always available for PATCH requests. + { # Represents a Kubernetes Subject. + "kind": "A String", # Authentication type for subject. + "name": "A String", # Name for subject. + "ns": "A String", # Namespace for subject. + }, + ], + }, + ], + "nodePools": [ # GKE Node Pools associated with the finding. This field will contain NodePool information for each Node, when it is available. + { # Provides GKE Node Pool information. + "name": "A String", # Kubernetes Node pool name. + "nodes": [ # Nodes associated with the finding. + { # Kubernetes Nodes associated with the finding. + "name": "A String", # Full Resource name of the Compute Engine VM running the cluster node. + }, + ], + }, + ], + "nodes": [ # Provides Kubernetes Node information. + { # Kubernetes Nodes associated with the finding. + "name": "A String", # Full Resource name of the Compute Engine VM running the cluster node. + }, + ], + "pods": [ # Kubernetes Pods associated with the finding. This field will contain Pod records for each container that is owned by a Pod. + { # Kubernetes Pod. + "containers": [ # Pod containers associated with this finding, if any. + { # Container associated with the finding. + "imageId": "A String", # Optional container image id, when provided by the container runtime. Uniquely identifies the container image launched using a container image digest. + "labels": [ # Container labels, as provided by the container runtime. + { # Label represents a generic name=value label. Label has separate name and value fields to support filtering with contains(). + "name": "A String", # Label name. + "value": "A String", # Label value. + }, + ], + "name": "A String", # Container name. + "uri": "A String", # Container image URI provided when configuring a pod/container. May identify a container image version using mutable tags. + }, + ], + "labels": [ # Pod labels. For Kubernetes containers, these are applied to the container. + { # Label represents a generic name=value label. Label has separate name and value fields to support filtering with contains(). + "name": "A String", # Label name. + "value": "A String", # Label value. + }, + ], + "name": "A String", # Kubernetes Pod name. + "ns": "A String", # Kubernetes Pod namespace. + }, + ], + "roles": [ # Provides Kubernetes role information for findings that involve Roles or ClusterRoles. + { # Kubernetes Role or ClusterRole. + "kind": "A String", # Role type. + "name": "A String", # Role name. + "ns": "A String", # Role namespace. + }, + ], + }, "mitreAttack": { # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org "additionalTactics": [ # Additional MITRE ATT&CK tactics related to this finding, if any. "A String", @@ -689,7 +871,7 @@

Method Details

"sourcePort": 42, # Source port. }, ], - "contacts": { # Output only. Map containing the point of contacts for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { "security":[ { "contact":{ "email":"person1@company.com" } }, { "contact":{ "email":“person2@company.com” } } ] } + "contacts": { # Output only. Map containing the point of contacts for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { "security": { "contacts": [ { "email": "person1@company.com" }, { "email": "person2@company.com" } ] } "a_key": { # The details pertaining to specific contacts "contacts": [ # A list of contacts { # Representa a single contact's email address @@ -698,6 +880,19 @@

Method Details

], }, }, + "containers": [ # Containers associated with the finding. containers provides information for both Kubernetes and non-Kubernetes containers. + { # Container associated with the finding. + "imageId": "A String", # Optional container image id, when provided by the container runtime. Uniquely identifies the container image launched using a container image digest. + "labels": [ # Container labels, as provided by the container runtime. + { # Label represents a generic name=value label. Label has separate name and value fields to support filtering with contains(). + "name": "A String", # Label name. + "value": "A String", # Label value. + }, + ], + "name": "A String", # Container name. + "uri": "A String", # Container image URI provided when configuring a pod/container. May identify a container image version using mutable tags. + }, + ], "createTime": "A String", # The time at which the finding was created in Security Command Center. "description": "A String", # Contains more detail about the finding. "eventTime": "A String", # The time the finding was first detected. If an existing finding is updated, then this is the time the update occurred. For example, if the finding represents an open firewall, this property captures the time the detector believes the firewall became open. The accuracy is determined by the detector. If the finding is later resolved, then this time reflects when the finding was resolved. This must not be set to a value greater than the current timestamp. @@ -763,6 +958,84 @@

Method Details

}, ], }, + "kubernetes": { # Kubernetes related attributes. # Kubernetes resources associated with the finding. + "accessReviews": [ # Provides information on any Kubernetes access reviews (i.e. privilege checks) relevant to the finding. + { # Conveys information about a Kubernetes access review (e.g. kubectl auth can-i ...) that was involved in a finding. + "group": "A String", # Group is the API Group of the Resource. "*" means all. + "name": "A String", # Name is the name of the resource being requested. Empty means all. + "ns": "A String", # Namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces. Both are represented by "" (empty). + "resource": "A String", # Resource is the optional resource type requested. "*" means all. + "subresource": "A String", # Subresource is the optional subresource type. + "verb": "A String", # Verb is a Kubernetes resource API verb, like: get, list, watch, create, update, delete, proxy. "*" means all. + "version": "A String", # Version is the API Version of the Resource. "*" means all. + }, + ], + "bindings": [ # Provides Kubernetes role binding information for findings that involve RoleBindings or ClusterRoleBindings. + { # Represents a Kubernetes RoleBinding or ClusterRoleBinding. + "name": "A String", # Name for binding. + "ns": "A String", # Namespace for binding. + "role": { # Kubernetes Role or ClusterRole. # The Role or ClusterRole referenced by the binding. + "kind": "A String", # Role type. + "name": "A String", # Role name. + "ns": "A String", # Role namespace. + }, + "subjects": [ # Represents the subjects(s) bound to the role. Not always available for PATCH requests. + { # Represents a Kubernetes Subject. + "kind": "A String", # Authentication type for subject. + "name": "A String", # Name for subject. + "ns": "A String", # Namespace for subject. + }, + ], + }, + ], + "nodePools": [ # GKE Node Pools associated with the finding. This field will contain NodePool information for each Node, when it is available. + { # Provides GKE Node Pool information. + "name": "A String", # Kubernetes Node pool name. + "nodes": [ # Nodes associated with the finding. + { # Kubernetes Nodes associated with the finding. + "name": "A String", # Full Resource name of the Compute Engine VM running the cluster node. + }, + ], + }, + ], + "nodes": [ # Provides Kubernetes Node information. + { # Kubernetes Nodes associated with the finding. + "name": "A String", # Full Resource name of the Compute Engine VM running the cluster node. + }, + ], + "pods": [ # Kubernetes Pods associated with the finding. This field will contain Pod records for each container that is owned by a Pod. + { # Kubernetes Pod. + "containers": [ # Pod containers associated with this finding, if any. + { # Container associated with the finding. + "imageId": "A String", # Optional container image id, when provided by the container runtime. Uniquely identifies the container image launched using a container image digest. + "labels": [ # Container labels, as provided by the container runtime. + { # Label represents a generic name=value label. Label has separate name and value fields to support filtering with contains(). + "name": "A String", # Label name. + "value": "A String", # Label value. + }, + ], + "name": "A String", # Container name. + "uri": "A String", # Container image URI provided when configuring a pod/container. May identify a container image version using mutable tags. + }, + ], + "labels": [ # Pod labels. For Kubernetes containers, these are applied to the container. + { # Label represents a generic name=value label. Label has separate name and value fields to support filtering with contains(). + "name": "A String", # Label name. + "value": "A String", # Label value. + }, + ], + "name": "A String", # Kubernetes Pod name. + "ns": "A String", # Kubernetes Pod namespace. + }, + ], + "roles": [ # Provides Kubernetes role information for findings that involve Roles or ClusterRoles. + { # Kubernetes Role or ClusterRole. + "kind": "A String", # Role type. + "name": "A String", # Role name. + "ns": "A String", # Role namespace. + }, + ], + }, "mitreAttack": { # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org "additionalTactics": [ # Additional MITRE ATT&CK tactics related to this finding, if any. "A String", @@ -917,7 +1190,7 @@

Method Details

"sourcePort": 42, # Source port. }, ], - "contacts": { # Output only. Map containing the point of contacts for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { "security":[ { "contact":{ "email":"person1@company.com" } }, { "contact":{ "email":“person2@company.com” } } ] } + "contacts": { # Output only. Map containing the point of contacts for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { "security": { "contacts": [ { "email": "person1@company.com" }, { "email": "person2@company.com" } ] } "a_key": { # The details pertaining to specific contacts "contacts": [ # A list of contacts { # Representa a single contact's email address @@ -926,6 +1199,19 @@

Method Details

], }, }, + "containers": [ # Containers associated with the finding. containers provides information for both Kubernetes and non-Kubernetes containers. + { # Container associated with the finding. + "imageId": "A String", # Optional container image id, when provided by the container runtime. Uniquely identifies the container image launched using a container image digest. + "labels": [ # Container labels, as provided by the container runtime. + { # Label represents a generic name=value label. Label has separate name and value fields to support filtering with contains(). + "name": "A String", # Label name. + "value": "A String", # Label value. + }, + ], + "name": "A String", # Container name. + "uri": "A String", # Container image URI provided when configuring a pod/container. May identify a container image version using mutable tags. + }, + ], "createTime": "A String", # The time at which the finding was created in Security Command Center. "description": "A String", # Contains more detail about the finding. "eventTime": "A String", # The time the finding was first detected. If an existing finding is updated, then this is the time the update occurred. For example, if the finding represents an open firewall, this property captures the time the detector believes the firewall became open. The accuracy is determined by the detector. If the finding is later resolved, then this time reflects when the finding was resolved. This must not be set to a value greater than the current timestamp. @@ -991,6 +1277,84 @@

Method Details

}, ], }, + "kubernetes": { # Kubernetes related attributes. # Kubernetes resources associated with the finding. + "accessReviews": [ # Provides information on any Kubernetes access reviews (i.e. privilege checks) relevant to the finding. + { # Conveys information about a Kubernetes access review (e.g. kubectl auth can-i ...) that was involved in a finding. + "group": "A String", # Group is the API Group of the Resource. "*" means all. + "name": "A String", # Name is the name of the resource being requested. Empty means all. + "ns": "A String", # Namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces. Both are represented by "" (empty). + "resource": "A String", # Resource is the optional resource type requested. "*" means all. + "subresource": "A String", # Subresource is the optional subresource type. + "verb": "A String", # Verb is a Kubernetes resource API verb, like: get, list, watch, create, update, delete, proxy. "*" means all. + "version": "A String", # Version is the API Version of the Resource. "*" means all. + }, + ], + "bindings": [ # Provides Kubernetes role binding information for findings that involve RoleBindings or ClusterRoleBindings. + { # Represents a Kubernetes RoleBinding or ClusterRoleBinding. + "name": "A String", # Name for binding. + "ns": "A String", # Namespace for binding. + "role": { # Kubernetes Role or ClusterRole. # The Role or ClusterRole referenced by the binding. + "kind": "A String", # Role type. + "name": "A String", # Role name. + "ns": "A String", # Role namespace. + }, + "subjects": [ # Represents the subjects(s) bound to the role. Not always available for PATCH requests. + { # Represents a Kubernetes Subject. + "kind": "A String", # Authentication type for subject. + "name": "A String", # Name for subject. + "ns": "A String", # Namespace for subject. + }, + ], + }, + ], + "nodePools": [ # GKE Node Pools associated with the finding. This field will contain NodePool information for each Node, when it is available. + { # Provides GKE Node Pool information. + "name": "A String", # Kubernetes Node pool name. + "nodes": [ # Nodes associated with the finding. + { # Kubernetes Nodes associated with the finding. + "name": "A String", # Full Resource name of the Compute Engine VM running the cluster node. + }, + ], + }, + ], + "nodes": [ # Provides Kubernetes Node information. + { # Kubernetes Nodes associated with the finding. + "name": "A String", # Full Resource name of the Compute Engine VM running the cluster node. + }, + ], + "pods": [ # Kubernetes Pods associated with the finding. This field will contain Pod records for each container that is owned by a Pod. + { # Kubernetes Pod. + "containers": [ # Pod containers associated with this finding, if any. + { # Container associated with the finding. + "imageId": "A String", # Optional container image id, when provided by the container runtime. Uniquely identifies the container image launched using a container image digest. + "labels": [ # Container labels, as provided by the container runtime. + { # Label represents a generic name=value label. Label has separate name and value fields to support filtering with contains(). + "name": "A String", # Label name. + "value": "A String", # Label value. + }, + ], + "name": "A String", # Container name. + "uri": "A String", # Container image URI provided when configuring a pod/container. May identify a container image version using mutable tags. + }, + ], + "labels": [ # Pod labels. For Kubernetes containers, these are applied to the container. + { # Label represents a generic name=value label. Label has separate name and value fields to support filtering with contains(). + "name": "A String", # Label name. + "value": "A String", # Label value. + }, + ], + "name": "A String", # Kubernetes Pod name. + "ns": "A String", # Kubernetes Pod namespace. + }, + ], + "roles": [ # Provides Kubernetes role information for findings that involve Roles or ClusterRoles. + { # Kubernetes Role or ClusterRole. + "kind": "A String", # Role type. + "name": "A String", # Role name. + "ns": "A String", # Role namespace. + }, + ], + }, "mitreAttack": { # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org "additionalTactics": [ # Additional MITRE ATT&CK tactics related to this finding, if any. "A String", @@ -1146,7 +1510,7 @@

Method Details

"sourcePort": 42, # Source port. }, ], - "contacts": { # Output only. Map containing the point of contacts for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { "security":[ { "contact":{ "email":"person1@company.com" } }, { "contact":{ "email":“person2@company.com” } } ] } + "contacts": { # Output only. Map containing the point of contacts for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { "security": { "contacts": [ { "email": "person1@company.com" }, { "email": "person2@company.com" } ] } "a_key": { # The details pertaining to specific contacts "contacts": [ # A list of contacts { # Representa a single contact's email address @@ -1155,6 +1519,19 @@

Method Details

], }, }, + "containers": [ # Containers associated with the finding. containers provides information for both Kubernetes and non-Kubernetes containers. + { # Container associated with the finding. + "imageId": "A String", # Optional container image id, when provided by the container runtime. Uniquely identifies the container image launched using a container image digest. + "labels": [ # Container labels, as provided by the container runtime. + { # Label represents a generic name=value label. Label has separate name and value fields to support filtering with contains(). + "name": "A String", # Label name. + "value": "A String", # Label value. + }, + ], + "name": "A String", # Container name. + "uri": "A String", # Container image URI provided when configuring a pod/container. May identify a container image version using mutable tags. + }, + ], "createTime": "A String", # The time at which the finding was created in Security Command Center. "description": "A String", # Contains more detail about the finding. "eventTime": "A String", # The time the finding was first detected. If an existing finding is updated, then this is the time the update occurred. For example, if the finding represents an open firewall, this property captures the time the detector believes the firewall became open. The accuracy is determined by the detector. If the finding is later resolved, then this time reflects when the finding was resolved. This must not be set to a value greater than the current timestamp. @@ -1220,6 +1597,84 @@

Method Details

}, ], }, + "kubernetes": { # Kubernetes related attributes. # Kubernetes resources associated with the finding. + "accessReviews": [ # Provides information on any Kubernetes access reviews (i.e. privilege checks) relevant to the finding. + { # Conveys information about a Kubernetes access review (e.g. kubectl auth can-i ...) that was involved in a finding. + "group": "A String", # Group is the API Group of the Resource. "*" means all. + "name": "A String", # Name is the name of the resource being requested. Empty means all. + "ns": "A String", # Namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces. Both are represented by "" (empty). + "resource": "A String", # Resource is the optional resource type requested. "*" means all. + "subresource": "A String", # Subresource is the optional subresource type. + "verb": "A String", # Verb is a Kubernetes resource API verb, like: get, list, watch, create, update, delete, proxy. "*" means all. + "version": "A String", # Version is the API Version of the Resource. "*" means all. + }, + ], + "bindings": [ # Provides Kubernetes role binding information for findings that involve RoleBindings or ClusterRoleBindings. + { # Represents a Kubernetes RoleBinding or ClusterRoleBinding. + "name": "A String", # Name for binding. + "ns": "A String", # Namespace for binding. + "role": { # Kubernetes Role or ClusterRole. # The Role or ClusterRole referenced by the binding. + "kind": "A String", # Role type. + "name": "A String", # Role name. + "ns": "A String", # Role namespace. + }, + "subjects": [ # Represents the subjects(s) bound to the role. Not always available for PATCH requests. + { # Represents a Kubernetes Subject. + "kind": "A String", # Authentication type for subject. + "name": "A String", # Name for subject. + "ns": "A String", # Namespace for subject. + }, + ], + }, + ], + "nodePools": [ # GKE Node Pools associated with the finding. This field will contain NodePool information for each Node, when it is available. + { # Provides GKE Node Pool information. + "name": "A String", # Kubernetes Node pool name. + "nodes": [ # Nodes associated with the finding. + { # Kubernetes Nodes associated with the finding. + "name": "A String", # Full Resource name of the Compute Engine VM running the cluster node. + }, + ], + }, + ], + "nodes": [ # Provides Kubernetes Node information. + { # Kubernetes Nodes associated with the finding. + "name": "A String", # Full Resource name of the Compute Engine VM running the cluster node. + }, + ], + "pods": [ # Kubernetes Pods associated with the finding. This field will contain Pod records for each container that is owned by a Pod. + { # Kubernetes Pod. + "containers": [ # Pod containers associated with this finding, if any. + { # Container associated with the finding. + "imageId": "A String", # Optional container image id, when provided by the container runtime. Uniquely identifies the container image launched using a container image digest. + "labels": [ # Container labels, as provided by the container runtime. + { # Label represents a generic name=value label. Label has separate name and value fields to support filtering with contains(). + "name": "A String", # Label name. + "value": "A String", # Label value. + }, + ], + "name": "A String", # Container name. + "uri": "A String", # Container image URI provided when configuring a pod/container. May identify a container image version using mutable tags. + }, + ], + "labels": [ # Pod labels. For Kubernetes containers, these are applied to the container. + { # Label represents a generic name=value label. Label has separate name and value fields to support filtering with contains(). + "name": "A String", # Label name. + "value": "A String", # Label value. + }, + ], + "name": "A String", # Kubernetes Pod name. + "ns": "A String", # Kubernetes Pod namespace. + }, + ], + "roles": [ # Provides Kubernetes role information for findings that involve Roles or ClusterRoles. + { # Kubernetes Role or ClusterRole. + "kind": "A String", # Role type. + "name": "A String", # Role name. + "ns": "A String", # Role namespace. + }, + ], + }, "mitreAttack": { # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org "additionalTactics": [ # Additional MITRE ATT&CK tactics related to this finding, if any. "A String", diff --git a/docs/dyn/securitycenter_v1.organizations.sources.findings.html b/docs/dyn/securitycenter_v1.organizations.sources.findings.html index a0cd52563a5..bb12e153a10 100644 --- a/docs/dyn/securitycenter_v1.organizations.sources.findings.html +++ b/docs/dyn/securitycenter_v1.organizations.sources.findings.html @@ -155,7 +155,7 @@

Method Details

"sourcePort": 42, # Source port. }, ], - "contacts": { # Output only. Map containing the point of contacts for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { "security":[ { "contact":{ "email":"person1@company.com" } }, { "contact":{ "email":“person2@company.com” } } ] } + "contacts": { # Output only. Map containing the point of contacts for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { "security": { "contacts": [ { "email": "person1@company.com" }, { "email": "person2@company.com" } ] } "a_key": { # The details pertaining to specific contacts "contacts": [ # A list of contacts { # Representa a single contact's email address @@ -164,6 +164,19 @@

Method Details

], }, }, + "containers": [ # Containers associated with the finding. containers provides information for both Kubernetes and non-Kubernetes containers. + { # Container associated with the finding. + "imageId": "A String", # Optional container image id, when provided by the container runtime. Uniquely identifies the container image launched using a container image digest. + "labels": [ # Container labels, as provided by the container runtime. + { # Label represents a generic name=value label. Label has separate name and value fields to support filtering with contains(). + "name": "A String", # Label name. + "value": "A String", # Label value. + }, + ], + "name": "A String", # Container name. + "uri": "A String", # Container image URI provided when configuring a pod/container. May identify a container image version using mutable tags. + }, + ], "createTime": "A String", # The time at which the finding was created in Security Command Center. "description": "A String", # Contains more detail about the finding. "eventTime": "A String", # The time the finding was first detected. If an existing finding is updated, then this is the time the update occurred. For example, if the finding represents an open firewall, this property captures the time the detector believes the firewall became open. The accuracy is determined by the detector. If the finding is later resolved, then this time reflects when the finding was resolved. This must not be set to a value greater than the current timestamp. @@ -229,6 +242,84 @@

Method Details

}, ], }, + "kubernetes": { # Kubernetes related attributes. # Kubernetes resources associated with the finding. + "accessReviews": [ # Provides information on any Kubernetes access reviews (i.e. privilege checks) relevant to the finding. + { # Conveys information about a Kubernetes access review (e.g. kubectl auth can-i ...) that was involved in a finding. + "group": "A String", # Group is the API Group of the Resource. "*" means all. + "name": "A String", # Name is the name of the resource being requested. Empty means all. + "ns": "A String", # Namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces. Both are represented by "" (empty). + "resource": "A String", # Resource is the optional resource type requested. "*" means all. + "subresource": "A String", # Subresource is the optional subresource type. + "verb": "A String", # Verb is a Kubernetes resource API verb, like: get, list, watch, create, update, delete, proxy. "*" means all. + "version": "A String", # Version is the API Version of the Resource. "*" means all. + }, + ], + "bindings": [ # Provides Kubernetes role binding information for findings that involve RoleBindings or ClusterRoleBindings. + { # Represents a Kubernetes RoleBinding or ClusterRoleBinding. + "name": "A String", # Name for binding. + "ns": "A String", # Namespace for binding. + "role": { # Kubernetes Role or ClusterRole. # The Role or ClusterRole referenced by the binding. + "kind": "A String", # Role type. + "name": "A String", # Role name. + "ns": "A String", # Role namespace. + }, + "subjects": [ # Represents the subjects(s) bound to the role. Not always available for PATCH requests. + { # Represents a Kubernetes Subject. + "kind": "A String", # Authentication type for subject. + "name": "A String", # Name for subject. + "ns": "A String", # Namespace for subject. + }, + ], + }, + ], + "nodePools": [ # GKE Node Pools associated with the finding. This field will contain NodePool information for each Node, when it is available. + { # Provides GKE Node Pool information. + "name": "A String", # Kubernetes Node pool name. + "nodes": [ # Nodes associated with the finding. + { # Kubernetes Nodes associated with the finding. + "name": "A String", # Full Resource name of the Compute Engine VM running the cluster node. + }, + ], + }, + ], + "nodes": [ # Provides Kubernetes Node information. + { # Kubernetes Nodes associated with the finding. + "name": "A String", # Full Resource name of the Compute Engine VM running the cluster node. + }, + ], + "pods": [ # Kubernetes Pods associated with the finding. This field will contain Pod records for each container that is owned by a Pod. + { # Kubernetes Pod. + "containers": [ # Pod containers associated with this finding, if any. + { # Container associated with the finding. + "imageId": "A String", # Optional container image id, when provided by the container runtime. Uniquely identifies the container image launched using a container image digest. + "labels": [ # Container labels, as provided by the container runtime. + { # Label represents a generic name=value label. Label has separate name and value fields to support filtering with contains(). + "name": "A String", # Label name. + "value": "A String", # Label value. + }, + ], + "name": "A String", # Container name. + "uri": "A String", # Container image URI provided when configuring a pod/container. May identify a container image version using mutable tags. + }, + ], + "labels": [ # Pod labels. For Kubernetes containers, these are applied to the container. + { # Label represents a generic name=value label. Label has separate name and value fields to support filtering with contains(). + "name": "A String", # Label name. + "value": "A String", # Label value. + }, + ], + "name": "A String", # Kubernetes Pod name. + "ns": "A String", # Kubernetes Pod namespace. + }, + ], + "roles": [ # Provides Kubernetes role information for findings that involve Roles or ClusterRoles. + { # Kubernetes Role or ClusterRole. + "kind": "A String", # Role type. + "name": "A String", # Role name. + "ns": "A String", # Role namespace. + }, + ], + }, "mitreAttack": { # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org "additionalTactics": [ # Additional MITRE ATT&CK tactics related to this finding, if any. "A String", @@ -370,7 +461,7 @@

Method Details

"sourcePort": 42, # Source port. }, ], - "contacts": { # Output only. Map containing the point of contacts for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { "security":[ { "contact":{ "email":"person1@company.com" } }, { "contact":{ "email":“person2@company.com” } } ] } + "contacts": { # Output only. Map containing the point of contacts for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { "security": { "contacts": [ { "email": "person1@company.com" }, { "email": "person2@company.com" } ] } "a_key": { # The details pertaining to specific contacts "contacts": [ # A list of contacts { # Representa a single contact's email address @@ -379,6 +470,19 @@

Method Details

], }, }, + "containers": [ # Containers associated with the finding. containers provides information for both Kubernetes and non-Kubernetes containers. + { # Container associated with the finding. + "imageId": "A String", # Optional container image id, when provided by the container runtime. Uniquely identifies the container image launched using a container image digest. + "labels": [ # Container labels, as provided by the container runtime. + { # Label represents a generic name=value label. Label has separate name and value fields to support filtering with contains(). + "name": "A String", # Label name. + "value": "A String", # Label value. + }, + ], + "name": "A String", # Container name. + "uri": "A String", # Container image URI provided when configuring a pod/container. May identify a container image version using mutable tags. + }, + ], "createTime": "A String", # The time at which the finding was created in Security Command Center. "description": "A String", # Contains more detail about the finding. "eventTime": "A String", # The time the finding was first detected. If an existing finding is updated, then this is the time the update occurred. For example, if the finding represents an open firewall, this property captures the time the detector believes the firewall became open. The accuracy is determined by the detector. If the finding is later resolved, then this time reflects when the finding was resolved. This must not be set to a value greater than the current timestamp. @@ -444,6 +548,84 @@

Method Details

}, ], }, + "kubernetes": { # Kubernetes related attributes. # Kubernetes resources associated with the finding. + "accessReviews": [ # Provides information on any Kubernetes access reviews (i.e. privilege checks) relevant to the finding. + { # Conveys information about a Kubernetes access review (e.g. kubectl auth can-i ...) that was involved in a finding. + "group": "A String", # Group is the API Group of the Resource. "*" means all. + "name": "A String", # Name is the name of the resource being requested. Empty means all. + "ns": "A String", # Namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces. Both are represented by "" (empty). + "resource": "A String", # Resource is the optional resource type requested. "*" means all. + "subresource": "A String", # Subresource is the optional subresource type. + "verb": "A String", # Verb is a Kubernetes resource API verb, like: get, list, watch, create, update, delete, proxy. "*" means all. + "version": "A String", # Version is the API Version of the Resource. "*" means all. + }, + ], + "bindings": [ # Provides Kubernetes role binding information for findings that involve RoleBindings or ClusterRoleBindings. + { # Represents a Kubernetes RoleBinding or ClusterRoleBinding. + "name": "A String", # Name for binding. + "ns": "A String", # Namespace for binding. + "role": { # Kubernetes Role or ClusterRole. # The Role or ClusterRole referenced by the binding. + "kind": "A String", # Role type. + "name": "A String", # Role name. + "ns": "A String", # Role namespace. + }, + "subjects": [ # Represents the subjects(s) bound to the role. Not always available for PATCH requests. + { # Represents a Kubernetes Subject. + "kind": "A String", # Authentication type for subject. + "name": "A String", # Name for subject. + "ns": "A String", # Namespace for subject. + }, + ], + }, + ], + "nodePools": [ # GKE Node Pools associated with the finding. This field will contain NodePool information for each Node, when it is available. + { # Provides GKE Node Pool information. + "name": "A String", # Kubernetes Node pool name. + "nodes": [ # Nodes associated with the finding. + { # Kubernetes Nodes associated with the finding. + "name": "A String", # Full Resource name of the Compute Engine VM running the cluster node. + }, + ], + }, + ], + "nodes": [ # Provides Kubernetes Node information. + { # Kubernetes Nodes associated with the finding. + "name": "A String", # Full Resource name of the Compute Engine VM running the cluster node. + }, + ], + "pods": [ # Kubernetes Pods associated with the finding. This field will contain Pod records for each container that is owned by a Pod. + { # Kubernetes Pod. + "containers": [ # Pod containers associated with this finding, if any. + { # Container associated with the finding. + "imageId": "A String", # Optional container image id, when provided by the container runtime. Uniquely identifies the container image launched using a container image digest. + "labels": [ # Container labels, as provided by the container runtime. + { # Label represents a generic name=value label. Label has separate name and value fields to support filtering with contains(). + "name": "A String", # Label name. + "value": "A String", # Label value. + }, + ], + "name": "A String", # Container name. + "uri": "A String", # Container image URI provided when configuring a pod/container. May identify a container image version using mutable tags. + }, + ], + "labels": [ # Pod labels. For Kubernetes containers, these are applied to the container. + { # Label represents a generic name=value label. Label has separate name and value fields to support filtering with contains(). + "name": "A String", # Label name. + "value": "A String", # Label value. + }, + ], + "name": "A String", # Kubernetes Pod name. + "ns": "A String", # Kubernetes Pod namespace. + }, + ], + "roles": [ # Provides Kubernetes role information for findings that involve Roles or ClusterRoles. + { # Kubernetes Role or ClusterRole. + "kind": "A String", # Role type. + "name": "A String", # Role name. + "ns": "A String", # Role namespace. + }, + ], + }, "mitreAttack": { # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org "additionalTactics": [ # Additional MITRE ATT&CK tactics related to this finding, if any. "A String", @@ -656,7 +838,7 @@

Method Details

"sourcePort": 42, # Source port. }, ], - "contacts": { # Output only. Map containing the point of contacts for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { "security":[ { "contact":{ "email":"person1@company.com" } }, { "contact":{ "email":“person2@company.com” } } ] } + "contacts": { # Output only. Map containing the point of contacts for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { "security": { "contacts": [ { "email": "person1@company.com" }, { "email": "person2@company.com" } ] } "a_key": { # The details pertaining to specific contacts "contacts": [ # A list of contacts { # Representa a single contact's email address @@ -665,6 +847,19 @@

Method Details

], }, }, + "containers": [ # Containers associated with the finding. containers provides information for both Kubernetes and non-Kubernetes containers. + { # Container associated with the finding. + "imageId": "A String", # Optional container image id, when provided by the container runtime. Uniquely identifies the container image launched using a container image digest. + "labels": [ # Container labels, as provided by the container runtime. + { # Label represents a generic name=value label. Label has separate name and value fields to support filtering with contains(). + "name": "A String", # Label name. + "value": "A String", # Label value. + }, + ], + "name": "A String", # Container name. + "uri": "A String", # Container image URI provided when configuring a pod/container. May identify a container image version using mutable tags. + }, + ], "createTime": "A String", # The time at which the finding was created in Security Command Center. "description": "A String", # Contains more detail about the finding. "eventTime": "A String", # The time the finding was first detected. If an existing finding is updated, then this is the time the update occurred. For example, if the finding represents an open firewall, this property captures the time the detector believes the firewall became open. The accuracy is determined by the detector. If the finding is later resolved, then this time reflects when the finding was resolved. This must not be set to a value greater than the current timestamp. @@ -730,6 +925,84 @@

Method Details

}, ], }, + "kubernetes": { # Kubernetes related attributes. # Kubernetes resources associated with the finding. + "accessReviews": [ # Provides information on any Kubernetes access reviews (i.e. privilege checks) relevant to the finding. + { # Conveys information about a Kubernetes access review (e.g. kubectl auth can-i ...) that was involved in a finding. + "group": "A String", # Group is the API Group of the Resource. "*" means all. + "name": "A String", # Name is the name of the resource being requested. Empty means all. + "ns": "A String", # Namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces. Both are represented by "" (empty). + "resource": "A String", # Resource is the optional resource type requested. "*" means all. + "subresource": "A String", # Subresource is the optional subresource type. + "verb": "A String", # Verb is a Kubernetes resource API verb, like: get, list, watch, create, update, delete, proxy. "*" means all. + "version": "A String", # Version is the API Version of the Resource. "*" means all. + }, + ], + "bindings": [ # Provides Kubernetes role binding information for findings that involve RoleBindings or ClusterRoleBindings. + { # Represents a Kubernetes RoleBinding or ClusterRoleBinding. + "name": "A String", # Name for binding. + "ns": "A String", # Namespace for binding. + "role": { # Kubernetes Role or ClusterRole. # The Role or ClusterRole referenced by the binding. + "kind": "A String", # Role type. + "name": "A String", # Role name. + "ns": "A String", # Role namespace. + }, + "subjects": [ # Represents the subjects(s) bound to the role. Not always available for PATCH requests. + { # Represents a Kubernetes Subject. + "kind": "A String", # Authentication type for subject. + "name": "A String", # Name for subject. + "ns": "A String", # Namespace for subject. + }, + ], + }, + ], + "nodePools": [ # GKE Node Pools associated with the finding. This field will contain NodePool information for each Node, when it is available. + { # Provides GKE Node Pool information. + "name": "A String", # Kubernetes Node pool name. + "nodes": [ # Nodes associated with the finding. + { # Kubernetes Nodes associated with the finding. + "name": "A String", # Full Resource name of the Compute Engine VM running the cluster node. + }, + ], + }, + ], + "nodes": [ # Provides Kubernetes Node information. + { # Kubernetes Nodes associated with the finding. + "name": "A String", # Full Resource name of the Compute Engine VM running the cluster node. + }, + ], + "pods": [ # Kubernetes Pods associated with the finding. This field will contain Pod records for each container that is owned by a Pod. + { # Kubernetes Pod. + "containers": [ # Pod containers associated with this finding, if any. + { # Container associated with the finding. + "imageId": "A String", # Optional container image id, when provided by the container runtime. Uniquely identifies the container image launched using a container image digest. + "labels": [ # Container labels, as provided by the container runtime. + { # Label represents a generic name=value label. Label has separate name and value fields to support filtering with contains(). + "name": "A String", # Label name. + "value": "A String", # Label value. + }, + ], + "name": "A String", # Container name. + "uri": "A String", # Container image URI provided when configuring a pod/container. May identify a container image version using mutable tags. + }, + ], + "labels": [ # Pod labels. For Kubernetes containers, these are applied to the container. + { # Label represents a generic name=value label. Label has separate name and value fields to support filtering with contains(). + "name": "A String", # Label name. + "value": "A String", # Label value. + }, + ], + "name": "A String", # Kubernetes Pod name. + "ns": "A String", # Kubernetes Pod namespace. + }, + ], + "roles": [ # Provides Kubernetes role information for findings that involve Roles or ClusterRoles. + { # Kubernetes Role or ClusterRole. + "kind": "A String", # Role type. + "name": "A String", # Role name. + "ns": "A String", # Role namespace. + }, + ], + }, "mitreAttack": { # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org "additionalTactics": [ # Additional MITRE ATT&CK tactics related to this finding, if any. "A String", @@ -908,7 +1181,7 @@

Method Details

"sourcePort": 42, # Source port. }, ], - "contacts": { # Output only. Map containing the point of contacts for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { "security":[ { "contact":{ "email":"person1@company.com" } }, { "contact":{ "email":“person2@company.com” } } ] } + "contacts": { # Output only. Map containing the point of contacts for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { "security": { "contacts": [ { "email": "person1@company.com" }, { "email": "person2@company.com" } ] } "a_key": { # The details pertaining to specific contacts "contacts": [ # A list of contacts { # Representa a single contact's email address @@ -917,6 +1190,19 @@

Method Details

], }, }, + "containers": [ # Containers associated with the finding. containers provides information for both Kubernetes and non-Kubernetes containers. + { # Container associated with the finding. + "imageId": "A String", # Optional container image id, when provided by the container runtime. Uniquely identifies the container image launched using a container image digest. + "labels": [ # Container labels, as provided by the container runtime. + { # Label represents a generic name=value label. Label has separate name and value fields to support filtering with contains(). + "name": "A String", # Label name. + "value": "A String", # Label value. + }, + ], + "name": "A String", # Container name. + "uri": "A String", # Container image URI provided when configuring a pod/container. May identify a container image version using mutable tags. + }, + ], "createTime": "A String", # The time at which the finding was created in Security Command Center. "description": "A String", # Contains more detail about the finding. "eventTime": "A String", # The time the finding was first detected. If an existing finding is updated, then this is the time the update occurred. For example, if the finding represents an open firewall, this property captures the time the detector believes the firewall became open. The accuracy is determined by the detector. If the finding is later resolved, then this time reflects when the finding was resolved. This must not be set to a value greater than the current timestamp. @@ -982,6 +1268,84 @@

Method Details

}, ], }, + "kubernetes": { # Kubernetes related attributes. # Kubernetes resources associated with the finding. + "accessReviews": [ # Provides information on any Kubernetes access reviews (i.e. privilege checks) relevant to the finding. + { # Conveys information about a Kubernetes access review (e.g. kubectl auth can-i ...) that was involved in a finding. + "group": "A String", # Group is the API Group of the Resource. "*" means all. + "name": "A String", # Name is the name of the resource being requested. Empty means all. + "ns": "A String", # Namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces. Both are represented by "" (empty). + "resource": "A String", # Resource is the optional resource type requested. "*" means all. + "subresource": "A String", # Subresource is the optional subresource type. + "verb": "A String", # Verb is a Kubernetes resource API verb, like: get, list, watch, create, update, delete, proxy. "*" means all. + "version": "A String", # Version is the API Version of the Resource. "*" means all. + }, + ], + "bindings": [ # Provides Kubernetes role binding information for findings that involve RoleBindings or ClusterRoleBindings. + { # Represents a Kubernetes RoleBinding or ClusterRoleBinding. + "name": "A String", # Name for binding. + "ns": "A String", # Namespace for binding. + "role": { # Kubernetes Role or ClusterRole. # The Role or ClusterRole referenced by the binding. + "kind": "A String", # Role type. + "name": "A String", # Role name. + "ns": "A String", # Role namespace. + }, + "subjects": [ # Represents the subjects(s) bound to the role. Not always available for PATCH requests. + { # Represents a Kubernetes Subject. + "kind": "A String", # Authentication type for subject. + "name": "A String", # Name for subject. + "ns": "A String", # Namespace for subject. + }, + ], + }, + ], + "nodePools": [ # GKE Node Pools associated with the finding. This field will contain NodePool information for each Node, when it is available. + { # Provides GKE Node Pool information. + "name": "A String", # Kubernetes Node pool name. + "nodes": [ # Nodes associated with the finding. + { # Kubernetes Nodes associated with the finding. + "name": "A String", # Full Resource name of the Compute Engine VM running the cluster node. + }, + ], + }, + ], + "nodes": [ # Provides Kubernetes Node information. + { # Kubernetes Nodes associated with the finding. + "name": "A String", # Full Resource name of the Compute Engine VM running the cluster node. + }, + ], + "pods": [ # Kubernetes Pods associated with the finding. This field will contain Pod records for each container that is owned by a Pod. + { # Kubernetes Pod. + "containers": [ # Pod containers associated with this finding, if any. + { # Container associated with the finding. + "imageId": "A String", # Optional container image id, when provided by the container runtime. Uniquely identifies the container image launched using a container image digest. + "labels": [ # Container labels, as provided by the container runtime. + { # Label represents a generic name=value label. Label has separate name and value fields to support filtering with contains(). + "name": "A String", # Label name. + "value": "A String", # Label value. + }, + ], + "name": "A String", # Container name. + "uri": "A String", # Container image URI provided when configuring a pod/container. May identify a container image version using mutable tags. + }, + ], + "labels": [ # Pod labels. For Kubernetes containers, these are applied to the container. + { # Label represents a generic name=value label. Label has separate name and value fields to support filtering with contains(). + "name": "A String", # Label name. + "value": "A String", # Label value. + }, + ], + "name": "A String", # Kubernetes Pod name. + "ns": "A String", # Kubernetes Pod namespace. + }, + ], + "roles": [ # Provides Kubernetes role information for findings that involve Roles or ClusterRoles. + { # Kubernetes Role or ClusterRole. + "kind": "A String", # Role type. + "name": "A String", # Role name. + "ns": "A String", # Role namespace. + }, + ], + }, "mitreAttack": { # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org "additionalTactics": [ # Additional MITRE ATT&CK tactics related to this finding, if any. "A String", @@ -1123,7 +1487,7 @@

Method Details

"sourcePort": 42, # Source port. }, ], - "contacts": { # Output only. Map containing the point of contacts for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { "security":[ { "contact":{ "email":"person1@company.com" } }, { "contact":{ "email":“person2@company.com” } } ] } + "contacts": { # Output only. Map containing the point of contacts for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { "security": { "contacts": [ { "email": "person1@company.com" }, { "email": "person2@company.com" } ] } "a_key": { # The details pertaining to specific contacts "contacts": [ # A list of contacts { # Representa a single contact's email address @@ -1132,6 +1496,19 @@

Method Details

], }, }, + "containers": [ # Containers associated with the finding. containers provides information for both Kubernetes and non-Kubernetes containers. + { # Container associated with the finding. + "imageId": "A String", # Optional container image id, when provided by the container runtime. Uniquely identifies the container image launched using a container image digest. + "labels": [ # Container labels, as provided by the container runtime. + { # Label represents a generic name=value label. Label has separate name and value fields to support filtering with contains(). + "name": "A String", # Label name. + "value": "A String", # Label value. + }, + ], + "name": "A String", # Container name. + "uri": "A String", # Container image URI provided when configuring a pod/container. May identify a container image version using mutable tags. + }, + ], "createTime": "A String", # The time at which the finding was created in Security Command Center. "description": "A String", # Contains more detail about the finding. "eventTime": "A String", # The time the finding was first detected. If an existing finding is updated, then this is the time the update occurred. For example, if the finding represents an open firewall, this property captures the time the detector believes the firewall became open. The accuracy is determined by the detector. If the finding is later resolved, then this time reflects when the finding was resolved. This must not be set to a value greater than the current timestamp. @@ -1197,6 +1574,84 @@

Method Details

}, ], }, + "kubernetes": { # Kubernetes related attributes. # Kubernetes resources associated with the finding. + "accessReviews": [ # Provides information on any Kubernetes access reviews (i.e. privilege checks) relevant to the finding. + { # Conveys information about a Kubernetes access review (e.g. kubectl auth can-i ...) that was involved in a finding. + "group": "A String", # Group is the API Group of the Resource. "*" means all. + "name": "A String", # Name is the name of the resource being requested. Empty means all. + "ns": "A String", # Namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces. Both are represented by "" (empty). + "resource": "A String", # Resource is the optional resource type requested. "*" means all. + "subresource": "A String", # Subresource is the optional subresource type. + "verb": "A String", # Verb is a Kubernetes resource API verb, like: get, list, watch, create, update, delete, proxy. "*" means all. + "version": "A String", # Version is the API Version of the Resource. "*" means all. + }, + ], + "bindings": [ # Provides Kubernetes role binding information for findings that involve RoleBindings or ClusterRoleBindings. + { # Represents a Kubernetes RoleBinding or ClusterRoleBinding. + "name": "A String", # Name for binding. + "ns": "A String", # Namespace for binding. + "role": { # Kubernetes Role or ClusterRole. # The Role or ClusterRole referenced by the binding. + "kind": "A String", # Role type. + "name": "A String", # Role name. + "ns": "A String", # Role namespace. + }, + "subjects": [ # Represents the subjects(s) bound to the role. Not always available for PATCH requests. + { # Represents a Kubernetes Subject. + "kind": "A String", # Authentication type for subject. + "name": "A String", # Name for subject. + "ns": "A String", # Namespace for subject. + }, + ], + }, + ], + "nodePools": [ # GKE Node Pools associated with the finding. This field will contain NodePool information for each Node, when it is available. + { # Provides GKE Node Pool information. + "name": "A String", # Kubernetes Node pool name. + "nodes": [ # Nodes associated with the finding. + { # Kubernetes Nodes associated with the finding. + "name": "A String", # Full Resource name of the Compute Engine VM running the cluster node. + }, + ], + }, + ], + "nodes": [ # Provides Kubernetes Node information. + { # Kubernetes Nodes associated with the finding. + "name": "A String", # Full Resource name of the Compute Engine VM running the cluster node. + }, + ], + "pods": [ # Kubernetes Pods associated with the finding. This field will contain Pod records for each container that is owned by a Pod. + { # Kubernetes Pod. + "containers": [ # Pod containers associated with this finding, if any. + { # Container associated with the finding. + "imageId": "A String", # Optional container image id, when provided by the container runtime. Uniquely identifies the container image launched using a container image digest. + "labels": [ # Container labels, as provided by the container runtime. + { # Label represents a generic name=value label. Label has separate name and value fields to support filtering with contains(). + "name": "A String", # Label name. + "value": "A String", # Label value. + }, + ], + "name": "A String", # Container name. + "uri": "A String", # Container image URI provided when configuring a pod/container. May identify a container image version using mutable tags. + }, + ], + "labels": [ # Pod labels. For Kubernetes containers, these are applied to the container. + { # Label represents a generic name=value label. Label has separate name and value fields to support filtering with contains(). + "name": "A String", # Label name. + "value": "A String", # Label value. + }, + ], + "name": "A String", # Kubernetes Pod name. + "ns": "A String", # Kubernetes Pod namespace. + }, + ], + "roles": [ # Provides Kubernetes role information for findings that involve Roles or ClusterRoles. + { # Kubernetes Role or ClusterRole. + "kind": "A String", # Role type. + "name": "A String", # Role name. + "ns": "A String", # Role namespace. + }, + ], + }, "mitreAttack": { # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org "additionalTactics": [ # Additional MITRE ATT&CK tactics related to this finding, if any. "A String", @@ -1351,7 +1806,7 @@

Method Details

"sourcePort": 42, # Source port. }, ], - "contacts": { # Output only. Map containing the point of contacts for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { "security":[ { "contact":{ "email":"person1@company.com" } }, { "contact":{ "email":“person2@company.com” } } ] } + "contacts": { # Output only. Map containing the point of contacts for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { "security": { "contacts": [ { "email": "person1@company.com" }, { "email": "person2@company.com" } ] } "a_key": { # The details pertaining to specific contacts "contacts": [ # A list of contacts { # Representa a single contact's email address @@ -1360,6 +1815,19 @@

Method Details

], }, }, + "containers": [ # Containers associated with the finding. containers provides information for both Kubernetes and non-Kubernetes containers. + { # Container associated with the finding. + "imageId": "A String", # Optional container image id, when provided by the container runtime. Uniquely identifies the container image launched using a container image digest. + "labels": [ # Container labels, as provided by the container runtime. + { # Label represents a generic name=value label. Label has separate name and value fields to support filtering with contains(). + "name": "A String", # Label name. + "value": "A String", # Label value. + }, + ], + "name": "A String", # Container name. + "uri": "A String", # Container image URI provided when configuring a pod/container. May identify a container image version using mutable tags. + }, + ], "createTime": "A String", # The time at which the finding was created in Security Command Center. "description": "A String", # Contains more detail about the finding. "eventTime": "A String", # The time the finding was first detected. If an existing finding is updated, then this is the time the update occurred. For example, if the finding represents an open firewall, this property captures the time the detector believes the firewall became open. The accuracy is determined by the detector. If the finding is later resolved, then this time reflects when the finding was resolved. This must not be set to a value greater than the current timestamp. @@ -1425,6 +1893,84 @@

Method Details

}, ], }, + "kubernetes": { # Kubernetes related attributes. # Kubernetes resources associated with the finding. + "accessReviews": [ # Provides information on any Kubernetes access reviews (i.e. privilege checks) relevant to the finding. + { # Conveys information about a Kubernetes access review (e.g. kubectl auth can-i ...) that was involved in a finding. + "group": "A String", # Group is the API Group of the Resource. "*" means all. + "name": "A String", # Name is the name of the resource being requested. Empty means all. + "ns": "A String", # Namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces. Both are represented by "" (empty). + "resource": "A String", # Resource is the optional resource type requested. "*" means all. + "subresource": "A String", # Subresource is the optional subresource type. + "verb": "A String", # Verb is a Kubernetes resource API verb, like: get, list, watch, create, update, delete, proxy. "*" means all. + "version": "A String", # Version is the API Version of the Resource. "*" means all. + }, + ], + "bindings": [ # Provides Kubernetes role binding information for findings that involve RoleBindings or ClusterRoleBindings. + { # Represents a Kubernetes RoleBinding or ClusterRoleBinding. + "name": "A String", # Name for binding. + "ns": "A String", # Namespace for binding. + "role": { # Kubernetes Role or ClusterRole. # The Role or ClusterRole referenced by the binding. + "kind": "A String", # Role type. + "name": "A String", # Role name. + "ns": "A String", # Role namespace. + }, + "subjects": [ # Represents the subjects(s) bound to the role. Not always available for PATCH requests. + { # Represents a Kubernetes Subject. + "kind": "A String", # Authentication type for subject. + "name": "A String", # Name for subject. + "ns": "A String", # Namespace for subject. + }, + ], + }, + ], + "nodePools": [ # GKE Node Pools associated with the finding. This field will contain NodePool information for each Node, when it is available. + { # Provides GKE Node Pool information. + "name": "A String", # Kubernetes Node pool name. + "nodes": [ # Nodes associated with the finding. + { # Kubernetes Nodes associated with the finding. + "name": "A String", # Full Resource name of the Compute Engine VM running the cluster node. + }, + ], + }, + ], + "nodes": [ # Provides Kubernetes Node information. + { # Kubernetes Nodes associated with the finding. + "name": "A String", # Full Resource name of the Compute Engine VM running the cluster node. + }, + ], + "pods": [ # Kubernetes Pods associated with the finding. This field will contain Pod records for each container that is owned by a Pod. + { # Kubernetes Pod. + "containers": [ # Pod containers associated with this finding, if any. + { # Container associated with the finding. + "imageId": "A String", # Optional container image id, when provided by the container runtime. Uniquely identifies the container image launched using a container image digest. + "labels": [ # Container labels, as provided by the container runtime. + { # Label represents a generic name=value label. Label has separate name and value fields to support filtering with contains(). + "name": "A String", # Label name. + "value": "A String", # Label value. + }, + ], + "name": "A String", # Container name. + "uri": "A String", # Container image URI provided when configuring a pod/container. May identify a container image version using mutable tags. + }, + ], + "labels": [ # Pod labels. For Kubernetes containers, these are applied to the container. + { # Label represents a generic name=value label. Label has separate name and value fields to support filtering with contains(). + "name": "A String", # Label name. + "value": "A String", # Label value. + }, + ], + "name": "A String", # Kubernetes Pod name. + "ns": "A String", # Kubernetes Pod namespace. + }, + ], + "roles": [ # Provides Kubernetes role information for findings that involve Roles or ClusterRoles. + { # Kubernetes Role or ClusterRole. + "kind": "A String", # Role type. + "name": "A String", # Role name. + "ns": "A String", # Role namespace. + }, + ], + }, "mitreAttack": { # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org "additionalTactics": [ # Additional MITRE ATT&CK tactics related to this finding, if any. "A String", @@ -1580,7 +2126,7 @@

Method Details

"sourcePort": 42, # Source port. }, ], - "contacts": { # Output only. Map containing the point of contacts for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { "security":[ { "contact":{ "email":"person1@company.com" } }, { "contact":{ "email":“person2@company.com” } } ] } + "contacts": { # Output only. Map containing the point of contacts for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { "security": { "contacts": [ { "email": "person1@company.com" }, { "email": "person2@company.com" } ] } "a_key": { # The details pertaining to specific contacts "contacts": [ # A list of contacts { # Representa a single contact's email address @@ -1589,6 +2135,19 @@

Method Details

], }, }, + "containers": [ # Containers associated with the finding. containers provides information for both Kubernetes and non-Kubernetes containers. + { # Container associated with the finding. + "imageId": "A String", # Optional container image id, when provided by the container runtime. Uniquely identifies the container image launched using a container image digest. + "labels": [ # Container labels, as provided by the container runtime. + { # Label represents a generic name=value label. Label has separate name and value fields to support filtering with contains(). + "name": "A String", # Label name. + "value": "A String", # Label value. + }, + ], + "name": "A String", # Container name. + "uri": "A String", # Container image URI provided when configuring a pod/container. May identify a container image version using mutable tags. + }, + ], "createTime": "A String", # The time at which the finding was created in Security Command Center. "description": "A String", # Contains more detail about the finding. "eventTime": "A String", # The time the finding was first detected. If an existing finding is updated, then this is the time the update occurred. For example, if the finding represents an open firewall, this property captures the time the detector believes the firewall became open. The accuracy is determined by the detector. If the finding is later resolved, then this time reflects when the finding was resolved. This must not be set to a value greater than the current timestamp. @@ -1654,6 +2213,84 @@

Method Details

}, ], }, + "kubernetes": { # Kubernetes related attributes. # Kubernetes resources associated with the finding. + "accessReviews": [ # Provides information on any Kubernetes access reviews (i.e. privilege checks) relevant to the finding. + { # Conveys information about a Kubernetes access review (e.g. kubectl auth can-i ...) that was involved in a finding. + "group": "A String", # Group is the API Group of the Resource. "*" means all. + "name": "A String", # Name is the name of the resource being requested. Empty means all. + "ns": "A String", # Namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces. Both are represented by "" (empty). + "resource": "A String", # Resource is the optional resource type requested. "*" means all. + "subresource": "A String", # Subresource is the optional subresource type. + "verb": "A String", # Verb is a Kubernetes resource API verb, like: get, list, watch, create, update, delete, proxy. "*" means all. + "version": "A String", # Version is the API Version of the Resource. "*" means all. + }, + ], + "bindings": [ # Provides Kubernetes role binding information for findings that involve RoleBindings or ClusterRoleBindings. + { # Represents a Kubernetes RoleBinding or ClusterRoleBinding. + "name": "A String", # Name for binding. + "ns": "A String", # Namespace for binding. + "role": { # Kubernetes Role or ClusterRole. # The Role or ClusterRole referenced by the binding. + "kind": "A String", # Role type. + "name": "A String", # Role name. + "ns": "A String", # Role namespace. + }, + "subjects": [ # Represents the subjects(s) bound to the role. Not always available for PATCH requests. + { # Represents a Kubernetes Subject. + "kind": "A String", # Authentication type for subject. + "name": "A String", # Name for subject. + "ns": "A String", # Namespace for subject. + }, + ], + }, + ], + "nodePools": [ # GKE Node Pools associated with the finding. This field will contain NodePool information for each Node, when it is available. + { # Provides GKE Node Pool information. + "name": "A String", # Kubernetes Node pool name. + "nodes": [ # Nodes associated with the finding. + { # Kubernetes Nodes associated with the finding. + "name": "A String", # Full Resource name of the Compute Engine VM running the cluster node. + }, + ], + }, + ], + "nodes": [ # Provides Kubernetes Node information. + { # Kubernetes Nodes associated with the finding. + "name": "A String", # Full Resource name of the Compute Engine VM running the cluster node. + }, + ], + "pods": [ # Kubernetes Pods associated with the finding. This field will contain Pod records for each container that is owned by a Pod. + { # Kubernetes Pod. + "containers": [ # Pod containers associated with this finding, if any. + { # Container associated with the finding. + "imageId": "A String", # Optional container image id, when provided by the container runtime. Uniquely identifies the container image launched using a container image digest. + "labels": [ # Container labels, as provided by the container runtime. + { # Label represents a generic name=value label. Label has separate name and value fields to support filtering with contains(). + "name": "A String", # Label name. + "value": "A String", # Label value. + }, + ], + "name": "A String", # Container name. + "uri": "A String", # Container image URI provided when configuring a pod/container. May identify a container image version using mutable tags. + }, + ], + "labels": [ # Pod labels. For Kubernetes containers, these are applied to the container. + { # Label represents a generic name=value label. Label has separate name and value fields to support filtering with contains(). + "name": "A String", # Label name. + "value": "A String", # Label value. + }, + ], + "name": "A String", # Kubernetes Pod name. + "ns": "A String", # Kubernetes Pod namespace. + }, + ], + "roles": [ # Provides Kubernetes role information for findings that involve Roles or ClusterRoles. + { # Kubernetes Role or ClusterRole. + "kind": "A String", # Role type. + "name": "A String", # Role name. + "ns": "A String", # Role namespace. + }, + ], + }, "mitreAttack": { # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org "additionalTactics": [ # Additional MITRE ATT&CK tactics related to this finding, if any. "A String", diff --git a/docs/dyn/securitycenter_v1.projects.sources.findings.html b/docs/dyn/securitycenter_v1.projects.sources.findings.html index 3ca492f39d8..f91a0dece9d 100644 --- a/docs/dyn/securitycenter_v1.projects.sources.findings.html +++ b/docs/dyn/securitycenter_v1.projects.sources.findings.html @@ -222,7 +222,7 @@

Method Details

"sourcePort": 42, # Source port. }, ], - "contacts": { # Output only. Map containing the point of contacts for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { "security":[ { "contact":{ "email":"person1@company.com" } }, { "contact":{ "email":“person2@company.com” } } ] } + "contacts": { # Output only. Map containing the point of contacts for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { "security": { "contacts": [ { "email": "person1@company.com" }, { "email": "person2@company.com" } ] } "a_key": { # The details pertaining to specific contacts "contacts": [ # A list of contacts { # Representa a single contact's email address @@ -231,6 +231,19 @@

Method Details

], }, }, + "containers": [ # Containers associated with the finding. containers provides information for both Kubernetes and non-Kubernetes containers. + { # Container associated with the finding. + "imageId": "A String", # Optional container image id, when provided by the container runtime. Uniquely identifies the container image launched using a container image digest. + "labels": [ # Container labels, as provided by the container runtime. + { # Label represents a generic name=value label. Label has separate name and value fields to support filtering with contains(). + "name": "A String", # Label name. + "value": "A String", # Label value. + }, + ], + "name": "A String", # Container name. + "uri": "A String", # Container image URI provided when configuring a pod/container. May identify a container image version using mutable tags. + }, + ], "createTime": "A String", # The time at which the finding was created in Security Command Center. "description": "A String", # Contains more detail about the finding. "eventTime": "A String", # The time the finding was first detected. If an existing finding is updated, then this is the time the update occurred. For example, if the finding represents an open firewall, this property captures the time the detector believes the firewall became open. The accuracy is determined by the detector. If the finding is later resolved, then this time reflects when the finding was resolved. This must not be set to a value greater than the current timestamp. @@ -296,6 +309,84 @@

Method Details

}, ], }, + "kubernetes": { # Kubernetes related attributes. # Kubernetes resources associated with the finding. + "accessReviews": [ # Provides information on any Kubernetes access reviews (i.e. privilege checks) relevant to the finding. + { # Conveys information about a Kubernetes access review (e.g. kubectl auth can-i ...) that was involved in a finding. + "group": "A String", # Group is the API Group of the Resource. "*" means all. + "name": "A String", # Name is the name of the resource being requested. Empty means all. + "ns": "A String", # Namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces. Both are represented by "" (empty). + "resource": "A String", # Resource is the optional resource type requested. "*" means all. + "subresource": "A String", # Subresource is the optional subresource type. + "verb": "A String", # Verb is a Kubernetes resource API verb, like: get, list, watch, create, update, delete, proxy. "*" means all. + "version": "A String", # Version is the API Version of the Resource. "*" means all. + }, + ], + "bindings": [ # Provides Kubernetes role binding information for findings that involve RoleBindings or ClusterRoleBindings. + { # Represents a Kubernetes RoleBinding or ClusterRoleBinding. + "name": "A String", # Name for binding. + "ns": "A String", # Namespace for binding. + "role": { # Kubernetes Role or ClusterRole. # The Role or ClusterRole referenced by the binding. + "kind": "A String", # Role type. + "name": "A String", # Role name. + "ns": "A String", # Role namespace. + }, + "subjects": [ # Represents the subjects(s) bound to the role. Not always available for PATCH requests. + { # Represents a Kubernetes Subject. + "kind": "A String", # Authentication type for subject. + "name": "A String", # Name for subject. + "ns": "A String", # Namespace for subject. + }, + ], + }, + ], + "nodePools": [ # GKE Node Pools associated with the finding. This field will contain NodePool information for each Node, when it is available. + { # Provides GKE Node Pool information. + "name": "A String", # Kubernetes Node pool name. + "nodes": [ # Nodes associated with the finding. + { # Kubernetes Nodes associated with the finding. + "name": "A String", # Full Resource name of the Compute Engine VM running the cluster node. + }, + ], + }, + ], + "nodes": [ # Provides Kubernetes Node information. + { # Kubernetes Nodes associated with the finding. + "name": "A String", # Full Resource name of the Compute Engine VM running the cluster node. + }, + ], + "pods": [ # Kubernetes Pods associated with the finding. This field will contain Pod records for each container that is owned by a Pod. + { # Kubernetes Pod. + "containers": [ # Pod containers associated with this finding, if any. + { # Container associated with the finding. + "imageId": "A String", # Optional container image id, when provided by the container runtime. Uniquely identifies the container image launched using a container image digest. + "labels": [ # Container labels, as provided by the container runtime. + { # Label represents a generic name=value label. Label has separate name and value fields to support filtering with contains(). + "name": "A String", # Label name. + "value": "A String", # Label value. + }, + ], + "name": "A String", # Container name. + "uri": "A String", # Container image URI provided when configuring a pod/container. May identify a container image version using mutable tags. + }, + ], + "labels": [ # Pod labels. For Kubernetes containers, these are applied to the container. + { # Label represents a generic name=value label. Label has separate name and value fields to support filtering with contains(). + "name": "A String", # Label name. + "value": "A String", # Label value. + }, + ], + "name": "A String", # Kubernetes Pod name. + "ns": "A String", # Kubernetes Pod namespace. + }, + ], + "roles": [ # Provides Kubernetes role information for findings that involve Roles or ClusterRoles. + { # Kubernetes Role or ClusterRole. + "kind": "A String", # Role type. + "name": "A String", # Role name. + "ns": "A String", # Role namespace. + }, + ], + }, "mitreAttack": { # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org "additionalTactics": [ # Additional MITRE ATT&CK tactics related to this finding, if any. "A String", @@ -474,7 +565,7 @@

Method Details

"sourcePort": 42, # Source port. }, ], - "contacts": { # Output only. Map containing the point of contacts for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { "security":[ { "contact":{ "email":"person1@company.com" } }, { "contact":{ "email":“person2@company.com” } } ] } + "contacts": { # Output only. Map containing the point of contacts for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { "security": { "contacts": [ { "email": "person1@company.com" }, { "email": "person2@company.com" } ] } "a_key": { # The details pertaining to specific contacts "contacts": [ # A list of contacts { # Representa a single contact's email address @@ -483,6 +574,19 @@

Method Details

], }, }, + "containers": [ # Containers associated with the finding. containers provides information for both Kubernetes and non-Kubernetes containers. + { # Container associated with the finding. + "imageId": "A String", # Optional container image id, when provided by the container runtime. Uniquely identifies the container image launched using a container image digest. + "labels": [ # Container labels, as provided by the container runtime. + { # Label represents a generic name=value label. Label has separate name and value fields to support filtering with contains(). + "name": "A String", # Label name. + "value": "A String", # Label value. + }, + ], + "name": "A String", # Container name. + "uri": "A String", # Container image URI provided when configuring a pod/container. May identify a container image version using mutable tags. + }, + ], "createTime": "A String", # The time at which the finding was created in Security Command Center. "description": "A String", # Contains more detail about the finding. "eventTime": "A String", # The time the finding was first detected. If an existing finding is updated, then this is the time the update occurred. For example, if the finding represents an open firewall, this property captures the time the detector believes the firewall became open. The accuracy is determined by the detector. If the finding is later resolved, then this time reflects when the finding was resolved. This must not be set to a value greater than the current timestamp. @@ -548,6 +652,84 @@

Method Details

}, ], }, + "kubernetes": { # Kubernetes related attributes. # Kubernetes resources associated with the finding. + "accessReviews": [ # Provides information on any Kubernetes access reviews (i.e. privilege checks) relevant to the finding. + { # Conveys information about a Kubernetes access review (e.g. kubectl auth can-i ...) that was involved in a finding. + "group": "A String", # Group is the API Group of the Resource. "*" means all. + "name": "A String", # Name is the name of the resource being requested. Empty means all. + "ns": "A String", # Namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces. Both are represented by "" (empty). + "resource": "A String", # Resource is the optional resource type requested. "*" means all. + "subresource": "A String", # Subresource is the optional subresource type. + "verb": "A String", # Verb is a Kubernetes resource API verb, like: get, list, watch, create, update, delete, proxy. "*" means all. + "version": "A String", # Version is the API Version of the Resource. "*" means all. + }, + ], + "bindings": [ # Provides Kubernetes role binding information for findings that involve RoleBindings or ClusterRoleBindings. + { # Represents a Kubernetes RoleBinding or ClusterRoleBinding. + "name": "A String", # Name for binding. + "ns": "A String", # Namespace for binding. + "role": { # Kubernetes Role or ClusterRole. # The Role or ClusterRole referenced by the binding. + "kind": "A String", # Role type. + "name": "A String", # Role name. + "ns": "A String", # Role namespace. + }, + "subjects": [ # Represents the subjects(s) bound to the role. Not always available for PATCH requests. + { # Represents a Kubernetes Subject. + "kind": "A String", # Authentication type for subject. + "name": "A String", # Name for subject. + "ns": "A String", # Namespace for subject. + }, + ], + }, + ], + "nodePools": [ # GKE Node Pools associated with the finding. This field will contain NodePool information for each Node, when it is available. + { # Provides GKE Node Pool information. + "name": "A String", # Kubernetes Node pool name. + "nodes": [ # Nodes associated with the finding. + { # Kubernetes Nodes associated with the finding. + "name": "A String", # Full Resource name of the Compute Engine VM running the cluster node. + }, + ], + }, + ], + "nodes": [ # Provides Kubernetes Node information. + { # Kubernetes Nodes associated with the finding. + "name": "A String", # Full Resource name of the Compute Engine VM running the cluster node. + }, + ], + "pods": [ # Kubernetes Pods associated with the finding. This field will contain Pod records for each container that is owned by a Pod. + { # Kubernetes Pod. + "containers": [ # Pod containers associated with this finding, if any. + { # Container associated with the finding. + "imageId": "A String", # Optional container image id, when provided by the container runtime. Uniquely identifies the container image launched using a container image digest. + "labels": [ # Container labels, as provided by the container runtime. + { # Label represents a generic name=value label. Label has separate name and value fields to support filtering with contains(). + "name": "A String", # Label name. + "value": "A String", # Label value. + }, + ], + "name": "A String", # Container name. + "uri": "A String", # Container image URI provided when configuring a pod/container. May identify a container image version using mutable tags. + }, + ], + "labels": [ # Pod labels. For Kubernetes containers, these are applied to the container. + { # Label represents a generic name=value label. Label has separate name and value fields to support filtering with contains(). + "name": "A String", # Label name. + "value": "A String", # Label value. + }, + ], + "name": "A String", # Kubernetes Pod name. + "ns": "A String", # Kubernetes Pod namespace. + }, + ], + "roles": [ # Provides Kubernetes role information for findings that involve Roles or ClusterRoles. + { # Kubernetes Role or ClusterRole. + "kind": "A String", # Role type. + "name": "A String", # Role name. + "ns": "A String", # Role namespace. + }, + ], + }, "mitreAttack": { # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org "additionalTactics": [ # Additional MITRE ATT&CK tactics related to this finding, if any. "A String", @@ -689,7 +871,7 @@

Method Details

"sourcePort": 42, # Source port. }, ], - "contacts": { # Output only. Map containing the point of contacts for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { "security":[ { "contact":{ "email":"person1@company.com" } }, { "contact":{ "email":“person2@company.com” } } ] } + "contacts": { # Output only. Map containing the point of contacts for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { "security": { "contacts": [ { "email": "person1@company.com" }, { "email": "person2@company.com" } ] } "a_key": { # The details pertaining to specific contacts "contacts": [ # A list of contacts { # Representa a single contact's email address @@ -698,6 +880,19 @@

Method Details

], }, }, + "containers": [ # Containers associated with the finding. containers provides information for both Kubernetes and non-Kubernetes containers. + { # Container associated with the finding. + "imageId": "A String", # Optional container image id, when provided by the container runtime. Uniquely identifies the container image launched using a container image digest. + "labels": [ # Container labels, as provided by the container runtime. + { # Label represents a generic name=value label. Label has separate name and value fields to support filtering with contains(). + "name": "A String", # Label name. + "value": "A String", # Label value. + }, + ], + "name": "A String", # Container name. + "uri": "A String", # Container image URI provided when configuring a pod/container. May identify a container image version using mutable tags. + }, + ], "createTime": "A String", # The time at which the finding was created in Security Command Center. "description": "A String", # Contains more detail about the finding. "eventTime": "A String", # The time the finding was first detected. If an existing finding is updated, then this is the time the update occurred. For example, if the finding represents an open firewall, this property captures the time the detector believes the firewall became open. The accuracy is determined by the detector. If the finding is later resolved, then this time reflects when the finding was resolved. This must not be set to a value greater than the current timestamp. @@ -763,6 +958,84 @@

Method Details

}, ], }, + "kubernetes": { # Kubernetes related attributes. # Kubernetes resources associated with the finding. + "accessReviews": [ # Provides information on any Kubernetes access reviews (i.e. privilege checks) relevant to the finding. + { # Conveys information about a Kubernetes access review (e.g. kubectl auth can-i ...) that was involved in a finding. + "group": "A String", # Group is the API Group of the Resource. "*" means all. + "name": "A String", # Name is the name of the resource being requested. Empty means all. + "ns": "A String", # Namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces. Both are represented by "" (empty). + "resource": "A String", # Resource is the optional resource type requested. "*" means all. + "subresource": "A String", # Subresource is the optional subresource type. + "verb": "A String", # Verb is a Kubernetes resource API verb, like: get, list, watch, create, update, delete, proxy. "*" means all. + "version": "A String", # Version is the API Version of the Resource. "*" means all. + }, + ], + "bindings": [ # Provides Kubernetes role binding information for findings that involve RoleBindings or ClusterRoleBindings. + { # Represents a Kubernetes RoleBinding or ClusterRoleBinding. + "name": "A String", # Name for binding. + "ns": "A String", # Namespace for binding. + "role": { # Kubernetes Role or ClusterRole. # The Role or ClusterRole referenced by the binding. + "kind": "A String", # Role type. + "name": "A String", # Role name. + "ns": "A String", # Role namespace. + }, + "subjects": [ # Represents the subjects(s) bound to the role. Not always available for PATCH requests. + { # Represents a Kubernetes Subject. + "kind": "A String", # Authentication type for subject. + "name": "A String", # Name for subject. + "ns": "A String", # Namespace for subject. + }, + ], + }, + ], + "nodePools": [ # GKE Node Pools associated with the finding. This field will contain NodePool information for each Node, when it is available. + { # Provides GKE Node Pool information. + "name": "A String", # Kubernetes Node pool name. + "nodes": [ # Nodes associated with the finding. + { # Kubernetes Nodes associated with the finding. + "name": "A String", # Full Resource name of the Compute Engine VM running the cluster node. + }, + ], + }, + ], + "nodes": [ # Provides Kubernetes Node information. + { # Kubernetes Nodes associated with the finding. + "name": "A String", # Full Resource name of the Compute Engine VM running the cluster node. + }, + ], + "pods": [ # Kubernetes Pods associated with the finding. This field will contain Pod records for each container that is owned by a Pod. + { # Kubernetes Pod. + "containers": [ # Pod containers associated with this finding, if any. + { # Container associated with the finding. + "imageId": "A String", # Optional container image id, when provided by the container runtime. Uniquely identifies the container image launched using a container image digest. + "labels": [ # Container labels, as provided by the container runtime. + { # Label represents a generic name=value label. Label has separate name and value fields to support filtering with contains(). + "name": "A String", # Label name. + "value": "A String", # Label value. + }, + ], + "name": "A String", # Container name. + "uri": "A String", # Container image URI provided when configuring a pod/container. May identify a container image version using mutable tags. + }, + ], + "labels": [ # Pod labels. For Kubernetes containers, these are applied to the container. + { # Label represents a generic name=value label. Label has separate name and value fields to support filtering with contains(). + "name": "A String", # Label name. + "value": "A String", # Label value. + }, + ], + "name": "A String", # Kubernetes Pod name. + "ns": "A String", # Kubernetes Pod namespace. + }, + ], + "roles": [ # Provides Kubernetes role information for findings that involve Roles or ClusterRoles. + { # Kubernetes Role or ClusterRole. + "kind": "A String", # Role type. + "name": "A String", # Role name. + "ns": "A String", # Role namespace. + }, + ], + }, "mitreAttack": { # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org "additionalTactics": [ # Additional MITRE ATT&CK tactics related to this finding, if any. "A String", @@ -917,7 +1190,7 @@

Method Details

"sourcePort": 42, # Source port. }, ], - "contacts": { # Output only. Map containing the point of contacts for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { "security":[ { "contact":{ "email":"person1@company.com" } }, { "contact":{ "email":“person2@company.com” } } ] } + "contacts": { # Output only. Map containing the point of contacts for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { "security": { "contacts": [ { "email": "person1@company.com" }, { "email": "person2@company.com" } ] } "a_key": { # The details pertaining to specific contacts "contacts": [ # A list of contacts { # Representa a single contact's email address @@ -926,6 +1199,19 @@

Method Details

], }, }, + "containers": [ # Containers associated with the finding. containers provides information for both Kubernetes and non-Kubernetes containers. + { # Container associated with the finding. + "imageId": "A String", # Optional container image id, when provided by the container runtime. Uniquely identifies the container image launched using a container image digest. + "labels": [ # Container labels, as provided by the container runtime. + { # Label represents a generic name=value label. Label has separate name and value fields to support filtering with contains(). + "name": "A String", # Label name. + "value": "A String", # Label value. + }, + ], + "name": "A String", # Container name. + "uri": "A String", # Container image URI provided when configuring a pod/container. May identify a container image version using mutable tags. + }, + ], "createTime": "A String", # The time at which the finding was created in Security Command Center. "description": "A String", # Contains more detail about the finding. "eventTime": "A String", # The time the finding was first detected. If an existing finding is updated, then this is the time the update occurred. For example, if the finding represents an open firewall, this property captures the time the detector believes the firewall became open. The accuracy is determined by the detector. If the finding is later resolved, then this time reflects when the finding was resolved. This must not be set to a value greater than the current timestamp. @@ -991,6 +1277,84 @@

Method Details

}, ], }, + "kubernetes": { # Kubernetes related attributes. # Kubernetes resources associated with the finding. + "accessReviews": [ # Provides information on any Kubernetes access reviews (i.e. privilege checks) relevant to the finding. + { # Conveys information about a Kubernetes access review (e.g. kubectl auth can-i ...) that was involved in a finding. + "group": "A String", # Group is the API Group of the Resource. "*" means all. + "name": "A String", # Name is the name of the resource being requested. Empty means all. + "ns": "A String", # Namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces. Both are represented by "" (empty). + "resource": "A String", # Resource is the optional resource type requested. "*" means all. + "subresource": "A String", # Subresource is the optional subresource type. + "verb": "A String", # Verb is a Kubernetes resource API verb, like: get, list, watch, create, update, delete, proxy. "*" means all. + "version": "A String", # Version is the API Version of the Resource. "*" means all. + }, + ], + "bindings": [ # Provides Kubernetes role binding information for findings that involve RoleBindings or ClusterRoleBindings. + { # Represents a Kubernetes RoleBinding or ClusterRoleBinding. + "name": "A String", # Name for binding. + "ns": "A String", # Namespace for binding. + "role": { # Kubernetes Role or ClusterRole. # The Role or ClusterRole referenced by the binding. + "kind": "A String", # Role type. + "name": "A String", # Role name. + "ns": "A String", # Role namespace. + }, + "subjects": [ # Represents the subjects(s) bound to the role. Not always available for PATCH requests. + { # Represents a Kubernetes Subject. + "kind": "A String", # Authentication type for subject. + "name": "A String", # Name for subject. + "ns": "A String", # Namespace for subject. + }, + ], + }, + ], + "nodePools": [ # GKE Node Pools associated with the finding. This field will contain NodePool information for each Node, when it is available. + { # Provides GKE Node Pool information. + "name": "A String", # Kubernetes Node pool name. + "nodes": [ # Nodes associated with the finding. + { # Kubernetes Nodes associated with the finding. + "name": "A String", # Full Resource name of the Compute Engine VM running the cluster node. + }, + ], + }, + ], + "nodes": [ # Provides Kubernetes Node information. + { # Kubernetes Nodes associated with the finding. + "name": "A String", # Full Resource name of the Compute Engine VM running the cluster node. + }, + ], + "pods": [ # Kubernetes Pods associated with the finding. This field will contain Pod records for each container that is owned by a Pod. + { # Kubernetes Pod. + "containers": [ # Pod containers associated with this finding, if any. + { # Container associated with the finding. + "imageId": "A String", # Optional container image id, when provided by the container runtime. Uniquely identifies the container image launched using a container image digest. + "labels": [ # Container labels, as provided by the container runtime. + { # Label represents a generic name=value label. Label has separate name and value fields to support filtering with contains(). + "name": "A String", # Label name. + "value": "A String", # Label value. + }, + ], + "name": "A String", # Container name. + "uri": "A String", # Container image URI provided when configuring a pod/container. May identify a container image version using mutable tags. + }, + ], + "labels": [ # Pod labels. For Kubernetes containers, these are applied to the container. + { # Label represents a generic name=value label. Label has separate name and value fields to support filtering with contains(). + "name": "A String", # Label name. + "value": "A String", # Label value. + }, + ], + "name": "A String", # Kubernetes Pod name. + "ns": "A String", # Kubernetes Pod namespace. + }, + ], + "roles": [ # Provides Kubernetes role information for findings that involve Roles or ClusterRoles. + { # Kubernetes Role or ClusterRole. + "kind": "A String", # Role type. + "name": "A String", # Role name. + "ns": "A String", # Role namespace. + }, + ], + }, "mitreAttack": { # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org "additionalTactics": [ # Additional MITRE ATT&CK tactics related to this finding, if any. "A String", @@ -1146,7 +1510,7 @@

Method Details

"sourcePort": 42, # Source port. }, ], - "contacts": { # Output only. Map containing the point of contacts for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { "security":[ { "contact":{ "email":"person1@company.com" } }, { "contact":{ "email":“person2@company.com” } } ] } + "contacts": { # Output only. Map containing the point of contacts for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { "security": { "contacts": [ { "email": "person1@company.com" }, { "email": "person2@company.com" } ] } "a_key": { # The details pertaining to specific contacts "contacts": [ # A list of contacts { # Representa a single contact's email address @@ -1155,6 +1519,19 @@

Method Details

], }, }, + "containers": [ # Containers associated with the finding. containers provides information for both Kubernetes and non-Kubernetes containers. + { # Container associated with the finding. + "imageId": "A String", # Optional container image id, when provided by the container runtime. Uniquely identifies the container image launched using a container image digest. + "labels": [ # Container labels, as provided by the container runtime. + { # Label represents a generic name=value label. Label has separate name and value fields to support filtering with contains(). + "name": "A String", # Label name. + "value": "A String", # Label value. + }, + ], + "name": "A String", # Container name. + "uri": "A String", # Container image URI provided when configuring a pod/container. May identify a container image version using mutable tags. + }, + ], "createTime": "A String", # The time at which the finding was created in Security Command Center. "description": "A String", # Contains more detail about the finding. "eventTime": "A String", # The time the finding was first detected. If an existing finding is updated, then this is the time the update occurred. For example, if the finding represents an open firewall, this property captures the time the detector believes the firewall became open. The accuracy is determined by the detector. If the finding is later resolved, then this time reflects when the finding was resolved. This must not be set to a value greater than the current timestamp. @@ -1220,6 +1597,84 @@

Method Details

}, ], }, + "kubernetes": { # Kubernetes related attributes. # Kubernetes resources associated with the finding. + "accessReviews": [ # Provides information on any Kubernetes access reviews (i.e. privilege checks) relevant to the finding. + { # Conveys information about a Kubernetes access review (e.g. kubectl auth can-i ...) that was involved in a finding. + "group": "A String", # Group is the API Group of the Resource. "*" means all. + "name": "A String", # Name is the name of the resource being requested. Empty means all. + "ns": "A String", # Namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces. Both are represented by "" (empty). + "resource": "A String", # Resource is the optional resource type requested. "*" means all. + "subresource": "A String", # Subresource is the optional subresource type. + "verb": "A String", # Verb is a Kubernetes resource API verb, like: get, list, watch, create, update, delete, proxy. "*" means all. + "version": "A String", # Version is the API Version of the Resource. "*" means all. + }, + ], + "bindings": [ # Provides Kubernetes role binding information for findings that involve RoleBindings or ClusterRoleBindings. + { # Represents a Kubernetes RoleBinding or ClusterRoleBinding. + "name": "A String", # Name for binding. + "ns": "A String", # Namespace for binding. + "role": { # Kubernetes Role or ClusterRole. # The Role or ClusterRole referenced by the binding. + "kind": "A String", # Role type. + "name": "A String", # Role name. + "ns": "A String", # Role namespace. + }, + "subjects": [ # Represents the subjects(s) bound to the role. Not always available for PATCH requests. + { # Represents a Kubernetes Subject. + "kind": "A String", # Authentication type for subject. + "name": "A String", # Name for subject. + "ns": "A String", # Namespace for subject. + }, + ], + }, + ], + "nodePools": [ # GKE Node Pools associated with the finding. This field will contain NodePool information for each Node, when it is available. + { # Provides GKE Node Pool information. + "name": "A String", # Kubernetes Node pool name. + "nodes": [ # Nodes associated with the finding. + { # Kubernetes Nodes associated with the finding. + "name": "A String", # Full Resource name of the Compute Engine VM running the cluster node. + }, + ], + }, + ], + "nodes": [ # Provides Kubernetes Node information. + { # Kubernetes Nodes associated with the finding. + "name": "A String", # Full Resource name of the Compute Engine VM running the cluster node. + }, + ], + "pods": [ # Kubernetes Pods associated with the finding. This field will contain Pod records for each container that is owned by a Pod. + { # Kubernetes Pod. + "containers": [ # Pod containers associated with this finding, if any. + { # Container associated with the finding. + "imageId": "A String", # Optional container image id, when provided by the container runtime. Uniquely identifies the container image launched using a container image digest. + "labels": [ # Container labels, as provided by the container runtime. + { # Label represents a generic name=value label. Label has separate name and value fields to support filtering with contains(). + "name": "A String", # Label name. + "value": "A String", # Label value. + }, + ], + "name": "A String", # Container name. + "uri": "A String", # Container image URI provided when configuring a pod/container. May identify a container image version using mutable tags. + }, + ], + "labels": [ # Pod labels. For Kubernetes containers, these are applied to the container. + { # Label represents a generic name=value label. Label has separate name and value fields to support filtering with contains(). + "name": "A String", # Label name. + "value": "A String", # Label value. + }, + ], + "name": "A String", # Kubernetes Pod name. + "ns": "A String", # Kubernetes Pod namespace. + }, + ], + "roles": [ # Provides Kubernetes role information for findings that involve Roles or ClusterRoles. + { # Kubernetes Role or ClusterRole. + "kind": "A String", # Role type. + "name": "A String", # Role name. + "ns": "A String", # Role namespace. + }, + ], + }, "mitreAttack": { # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org # MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org "additionalTactics": [ # Additional MITRE ATT&CK tactics related to this finding, if any. "A String", diff --git a/docs/dyn/securitycenter_v1beta2.folders.html b/docs/dyn/securitycenter_v1beta2.folders.html index dcda1598925..5cc9c1d5bbb 100644 --- a/docs/dyn/securitycenter_v1beta2.folders.html +++ b/docs/dyn/securitycenter_v1beta2.folders.html @@ -278,10 +278,10 @@

Method Details

An object of the form: { # Resource capturing the settings for Security Center. - "logSinkProject": "A String", # The resource name of the project to send logs to. This project must be part of the organization this resource resides in. The format is `projects/{project_id}`. An empty value disables logging. This value is only referenced by services that support log sink. Please refer to the documentation for an updated list of compatible services. + "logSinkProject": "A String", # The resource name of the project to send logs to. This project must be part of the organization this resource resides in. The format is `projects/{project_id}`. An empty value disables logging. This value is only referenced by services that support log sink. Please refer to the documentation for an updated list of compatible services. This may only be specified for organization level onboarding. "name": "A String", # The resource name of the SecurityCenterSettings. Format: organizations/{organization}/securityCenterSettings Format: folders/{folder}/securityCenterSettings Format: projects/{project}/securityCenterSettings - "onboardingTime": "A String", # Timestamp of when the customer organization was onboarded to SCC. - "orgServiceAccount": "A String", # The organization level service account to be used for security center components. + "onboardingTime": "A String", # Output only. Timestamp of when the customer organization was onboarded to SCC. + "orgServiceAccount": "A String", # Output only. The organization level service account to be used for security center components. }
diff --git a/docs/dyn/securitycenter_v1beta2.organizations.html b/docs/dyn/securitycenter_v1beta2.organizations.html index 6c899cdf563..adb1c3997ed 100644 --- a/docs/dyn/securitycenter_v1beta2.organizations.html +++ b/docs/dyn/securitycenter_v1beta2.organizations.html @@ -281,10 +281,10 @@

Method Details

An object of the form: { # Resource capturing the settings for Security Center. - "logSinkProject": "A String", # The resource name of the project to send logs to. This project must be part of the organization this resource resides in. The format is `projects/{project_id}`. An empty value disables logging. This value is only referenced by services that support log sink. Please refer to the documentation for an updated list of compatible services. + "logSinkProject": "A String", # The resource name of the project to send logs to. This project must be part of the organization this resource resides in. The format is `projects/{project_id}`. An empty value disables logging. This value is only referenced by services that support log sink. Please refer to the documentation for an updated list of compatible services. This may only be specified for organization level onboarding. "name": "A String", # The resource name of the SecurityCenterSettings. Format: organizations/{organization}/securityCenterSettings Format: folders/{folder}/securityCenterSettings Format: projects/{project}/securityCenterSettings - "onboardingTime": "A String", # Timestamp of when the customer organization was onboarded to SCC. - "orgServiceAccount": "A String", # The organization level service account to be used for security center components. + "onboardingTime": "A String", # Output only. Timestamp of when the customer organization was onboarded to SCC. + "orgServiceAccount": "A String", # Output only. The organization level service account to be used for security center components. }
diff --git a/docs/dyn/securitycenter_v1beta2.projects.html b/docs/dyn/securitycenter_v1beta2.projects.html index 3fdabc71d06..89e83f7bb58 100644 --- a/docs/dyn/securitycenter_v1beta2.projects.html +++ b/docs/dyn/securitycenter_v1beta2.projects.html @@ -283,10 +283,10 @@

Method Details

An object of the form: { # Resource capturing the settings for Security Center. - "logSinkProject": "A String", # The resource name of the project to send logs to. This project must be part of the organization this resource resides in. The format is `projects/{project_id}`. An empty value disables logging. This value is only referenced by services that support log sink. Please refer to the documentation for an updated list of compatible services. + "logSinkProject": "A String", # The resource name of the project to send logs to. This project must be part of the organization this resource resides in. The format is `projects/{project_id}`. An empty value disables logging. This value is only referenced by services that support log sink. Please refer to the documentation for an updated list of compatible services. This may only be specified for organization level onboarding. "name": "A String", # The resource name of the SecurityCenterSettings. Format: organizations/{organization}/securityCenterSettings Format: folders/{folder}/securityCenterSettings Format: projects/{project}/securityCenterSettings - "onboardingTime": "A String", # Timestamp of when the customer organization was onboarded to SCC. - "orgServiceAccount": "A String", # The organization level service account to be used for security center components. + "onboardingTime": "A String", # Output only. Timestamp of when the customer organization was onboarded to SCC. + "orgServiceAccount": "A String", # Output only. The organization level service account to be used for security center components. }
diff --git a/googleapiclient/discovery_cache/documents/securitycenter.v1.json b/googleapiclient/discovery_cache/documents/securitycenter.v1.json index 2283f7b19c9..48a16781de1 100644 --- a/googleapiclient/discovery_cache/documents/securitycenter.v1.json +++ b/googleapiclient/discovery_cache/documents/securitycenter.v1.json @@ -3058,7 +3058,7 @@ } } }, - "revision": "20220707", + "revision": "20220713", "rootUrl": "https://securitycenter.googleapis.com/", "schemas": { "Access": { @@ -3092,6 +3092,41 @@ }, "type": "object" }, + "AccessReview": { + "description": "Conveys information about a Kubernetes access review (e.g. kubectl auth can-i ...) that was involved in a finding.", + "id": "AccessReview", + "properties": { + "group": { + "description": "Group is the API Group of the Resource. \"*\" means all.", + "type": "string" + }, + "name": { + "description": "Name is the name of the resource being requested. Empty means all.", + "type": "string" + }, + "ns": { + "description": "Namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces. Both are represented by \"\" (empty).", + "type": "string" + }, + "resource": { + "description": "Resource is the optional resource type requested. \"*\" means all.", + "type": "string" + }, + "subresource": { + "description": "Subresource is the optional subresource type.", + "type": "string" + }, + "verb": { + "description": "Verb is a Kubernetes resource API verb, like: get, list, watch, create, update, delete, proxy. \"*\" means all.", + "type": "string" + }, + "version": { + "description": "Version is the API Version of the Resource. \"*\" means all.", + "type": "string" + } + }, + "type": "object" + }, "Asset": { "description": "Security Command Center representation of a Google Cloud resource. The Asset is a Security Command Center resource that captures information about a single Google Cloud resource. All modifications to an Asset are only within the context of Security Command Center and don't affect the referenced Google Cloud resource.", "id": "Asset", @@ -3348,6 +3383,32 @@ }, "type": "object" }, + "Container": { + "description": "Container associated with the finding.", + "id": "Container", + "properties": { + "imageId": { + "description": "Optional container image id, when provided by the container runtime. Uniquely identifies the container image launched using a container image digest.", + "type": "string" + }, + "labels": { + "description": "Container labels, as provided by the container runtime.", + "items": { + "$ref": "Label" + }, + "type": "array" + }, + "name": { + "description": "Container name.", + "type": "string" + }, + "uri": { + "description": "Container image URI provided when configuring a pod/container. May identify a container image version using mutable tags.", + "type": "string" + } + }, + "type": "object" + }, "Cve": { "description": "CVE stands for Common Vulnerabilities and Exposures. More information: https://cve.mitre.org", "id": "Cve", @@ -3676,10 +3737,17 @@ "additionalProperties": { "$ref": "ContactDetails" }, - "description": "Output only. Map containing the point of contacts for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { \"security\":[ { \"contact\":{ \"email\":\"person1@company.com\" } }, { \"contact\":{ \"email\":\u201cperson2@company.com\u201d } } ] }", + "description": "Output only. Map containing the point of contacts for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { \"security\": { \"contacts\": [ { \"email\": \"person1@company.com\" }, { \"email\": \"person2@company.com\" } ] }", "readOnly": true, "type": "object" }, + "containers": { + "description": "Containers associated with the finding. containers provides information for both Kubernetes and non-Kubernetes containers.", + "items": { + "$ref": "Container" + }, + "type": "array" + }, "createTime": { "description": "The time at which the finding was created in Security Command Center.", "format": "google-datetime", @@ -3741,6 +3809,10 @@ "$ref": "Indicator", "description": "Represents what's commonly known as an Indicator of compromise (IoC) in computer forensics. This is an artifact observed on a network or in an operating system that, with high confidence, indicates a computer intrusion. Reference: https://en.wikipedia.org/wiki/Indicator_of_compromise" }, + "kubernetes": { + "$ref": "Kubernetes", + "description": "Kubernetes resources associated with the finding." + }, "mitreAttack": { "$ref": "MitreAttack", "description": "MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org" @@ -3939,6 +4011,32 @@ }, "type": "object" }, + "GoogleCloudSecuritycenterV1Binding": { + "description": "Represents a Kubernetes RoleBinding or ClusterRoleBinding.", + "id": "GoogleCloudSecuritycenterV1Binding", + "properties": { + "name": { + "description": "Name for binding.", + "type": "string" + }, + "ns": { + "description": "Namespace for binding.", + "type": "string" + }, + "role": { + "$ref": "Role", + "description": "The Role or ClusterRole referenced by the binding." + }, + "subjects": { + "description": "Represents the subjects(s) bound to the role. Not always available for PATCH requests.", + "items": { + "$ref": "Subject" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudSecuritycenterV1BulkMuteFindingsResponse": { "description": "The response to a BulkMute request. Contains the LRO information.", "id": "GoogleCloudSecuritycenterV1BulkMuteFindingsResponse", @@ -4549,6 +4647,70 @@ }, "type": "object" }, + "Kubernetes": { + "description": "Kubernetes related attributes.", + "id": "Kubernetes", + "properties": { + "accessReviews": { + "description": "Provides information on any Kubernetes access reviews (i.e. privilege checks) relevant to the finding.", + "items": { + "$ref": "AccessReview" + }, + "type": "array" + }, + "bindings": { + "description": "Provides Kubernetes role binding information for findings that involve RoleBindings or ClusterRoleBindings.", + "items": { + "$ref": "GoogleCloudSecuritycenterV1Binding" + }, + "type": "array" + }, + "nodePools": { + "description": "GKE Node Pools associated with the finding. This field will contain NodePool information for each Node, when it is available.", + "items": { + "$ref": "NodePool" + }, + "type": "array" + }, + "nodes": { + "description": "Provides Kubernetes Node information.", + "items": { + "$ref": "Node" + }, + "type": "array" + }, + "pods": { + "description": "Kubernetes Pods associated with the finding. This field will contain Pod records for each container that is owned by a Pod.", + "items": { + "$ref": "Pod" + }, + "type": "array" + }, + "roles": { + "description": "Provides Kubernetes role information for findings that involve Roles or ClusterRoles.", + "items": { + "$ref": "Role" + }, + "type": "array" + } + }, + "type": "object" + }, + "Label": { + "description": "Label represents a generic name=value label. Label has separate name and value fields to support filtering with contains().", + "id": "Label", + "properties": { + "name": { + "description": "Label name.", + "type": "string" + }, + "value": { + "description": "Label value.", + "type": "string" + } + }, + "type": "object" + }, "ListAssetsResponse": { "description": "Response message for listing assets.", "id": "ListAssetsResponse", @@ -4854,7 +5016,8 @@ "MODIFY_AUTHENTICATION_PROCESS", "DATA_DESTRUCTION", "DOMAIN_POLICY_MODIFICATION", - "IMPAIR_DEFENSES" + "IMPAIR_DEFENSES", + "NETWORK_SERVICE_DISCOVERY" ], "enumDescriptions": [ "Unspecified value.", @@ -4888,7 +5051,8 @@ "T1556", "T1485", "T1484", - "T1562" + "T1562", + "T1046" ], "type": "string" }, @@ -4967,7 +5131,8 @@ "MODIFY_AUTHENTICATION_PROCESS", "DATA_DESTRUCTION", "DOMAIN_POLICY_MODIFICATION", - "IMPAIR_DEFENSES" + "IMPAIR_DEFENSES", + "NETWORK_SERVICE_DISCOVERY" ], "enumDescriptions": [ "Unspecified value.", @@ -5001,7 +5166,8 @@ "T1556", "T1485", "T1484", - "T1562" + "T1562", + "T1046" ], "type": "string" }, @@ -5014,6 +5180,35 @@ }, "type": "object" }, + "Node": { + "description": "Kubernetes Nodes associated with the finding.", + "id": "Node", + "properties": { + "name": { + "description": "Full Resource name of the Compute Engine VM running the cluster node.", + "type": "string" + } + }, + "type": "object" + }, + "NodePool": { + "description": "Provides GKE Node Pool information.", + "id": "NodePool", + "properties": { + "name": { + "description": "Kubernetes Node pool name.", + "type": "string" + }, + "nodes": { + "description": "Nodes associated with the finding.", + "items": { + "$ref": "Node" + }, + "type": "array" + } + }, + "type": "object" + }, "NotificationConfig": { "description": "Cloud Security Command Center (Cloud SCC) notification configs. A notification config is a Cloud SCC resource that contains the configuration to send notifications for create/update events of findings, assets and etc.", "id": "NotificationConfig", @@ -5096,6 +5291,35 @@ }, "type": "object" }, + "Pod": { + "description": "Kubernetes Pod.", + "id": "Pod", + "properties": { + "containers": { + "description": "Pod containers associated with this finding, if any.", + "items": { + "$ref": "Container" + }, + "type": "array" + }, + "labels": { + "description": "Pod labels. For Kubernetes containers, these are applied to the container.", + "items": { + "$ref": "Label" + }, + "type": "array" + }, + "name": { + "description": "Kubernetes Pod name.", + "type": "string" + }, + "ns": { + "description": "Kubernetes Pod namespace.", + "type": "string" + } + }, + "type": "object" + }, "Policy": { "description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).", "id": "Policy", @@ -5257,6 +5481,35 @@ }, "type": "object" }, + "Role": { + "description": "Kubernetes Role or ClusterRole.", + "id": "Role", + "properties": { + "kind": { + "description": "Role type.", + "enum": [ + "KIND_UNSPECIFIED", + "ROLE", + "CLUSTER_ROLE" + ], + "enumDescriptions": [ + "Role type is not specified.", + "Kubernetes Role.", + "Kubernetes ClusterRole." + ], + "type": "string" + }, + "name": { + "description": "Role name.", + "type": "string" + }, + "ns": { + "description": "Role namespace.", + "type": "string" + } + }, + "type": "object" + }, "RunAssetDiscoveryRequest": { "description": "Request message for running asset discovery for an organization.", "id": "RunAssetDiscoveryRequest", @@ -5460,6 +5713,37 @@ }, "type": "object" }, + "Subject": { + "description": "Represents a Kubernetes Subject.", + "id": "Subject", + "properties": { + "kind": { + "description": "Authentication type for subject.", + "enum": [ + "AUTH_TYPE_UNSPECIFIED", + "USER", + "SERVICEACCOUNT", + "GROUP" + ], + "enumDescriptions": [ + "Authentication is not specified.", + "User with valid certificate.", + "Users managed by Kubernetes API with credentials stored as Secrets.", + "Collection of users." + ], + "type": "string" + }, + "name": { + "description": "Name for subject.", + "type": "string" + }, + "ns": { + "description": "Namespace for subject.", + "type": "string" + } + }, + "type": "object" + }, "TestIamPermissionsRequest": { "description": "Request message for `TestIamPermissions` method.", "id": "TestIamPermissionsRequest", diff --git a/googleapiclient/discovery_cache/documents/securitycenter.v1beta1.json b/googleapiclient/discovery_cache/documents/securitycenter.v1beta1.json index fad1506182f..94626160b10 100644 --- a/googleapiclient/discovery_cache/documents/securitycenter.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/securitycenter.v1beta1.json @@ -896,7 +896,7 @@ } } }, - "revision": "20220707", + "revision": "20220713", "rootUrl": "https://securitycenter.googleapis.com/", "schemas": { "Access": { @@ -930,6 +930,41 @@ }, "type": "object" }, + "AccessReview": { + "description": "Conveys information about a Kubernetes access review (e.g. kubectl auth can-i ...) that was involved in a finding.", + "id": "AccessReview", + "properties": { + "group": { + "description": "Group is the API Group of the Resource. \"*\" means all.", + "type": "string" + }, + "name": { + "description": "Name is the name of the resource being requested. Empty means all.", + "type": "string" + }, + "ns": { + "description": "Namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces. Both are represented by \"\" (empty).", + "type": "string" + }, + "resource": { + "description": "Resource is the optional resource type requested. \"*\" means all.", + "type": "string" + }, + "subresource": { + "description": "Subresource is the optional subresource type.", + "type": "string" + }, + "verb": { + "description": "Verb is a Kubernetes resource API verb, like: get, list, watch, create, update, delete, proxy. \"*\" means all.", + "type": "string" + }, + "version": { + "description": "Version is the API Version of the Resource. \"*\" means all.", + "type": "string" + } + }, + "type": "object" + }, "Asset": { "description": "Security Command Center representation of a Google Cloud resource. The Asset is a Security Command Center resource that captures information about a single Google Cloud resource. All modifications to an Asset are only within the context of Security Command Center and don't affect the referenced Google Cloud resource.", "id": "Asset", @@ -1162,6 +1197,32 @@ }, "type": "object" }, + "Container": { + "description": "Container associated with the finding.", + "id": "Container", + "properties": { + "imageId": { + "description": "Optional container image id, when provided by the container runtime. Uniquely identifies the container image launched using a container image digest.", + "type": "string" + }, + "labels": { + "description": "Container labels, as provided by the container runtime.", + "items": { + "$ref": "Label" + }, + "type": "array" + }, + "name": { + "description": "Container name.", + "type": "string" + }, + "uri": { + "description": "Container image URI provided when configuring a pod/container. May identify a container image version using mutable tags.", + "type": "string" + } + }, + "type": "object" + }, "Cve": { "description": "CVE stands for Common Vulnerabilities and Exposures. More information: https://cve.mitre.org", "id": "Cve", @@ -1490,10 +1551,17 @@ "additionalProperties": { "$ref": "ContactDetails" }, - "description": "Output only. Map containing the point of contacts for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { \"security\":[ { \"contact\":{ \"email\":\"person1@company.com\" } }, { \"contact\":{ \"email\":\u201cperson2@company.com\u201d } } ] }", + "description": "Output only. Map containing the point of contacts for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { \"security\": { \"contacts\": [ { \"email\": \"person1@company.com\" }, { \"email\": \"person2@company.com\" } ] }", "readOnly": true, "type": "object" }, + "containers": { + "description": "Containers associated with the finding. containers provides information for both Kubernetes and non-Kubernetes containers.", + "items": { + "$ref": "Container" + }, + "type": "array" + }, "createTime": { "description": "The time at which the finding was created in Security Command Center.", "format": "google-datetime", @@ -1555,6 +1623,10 @@ "$ref": "Indicator", "description": "Represents what's commonly known as an Indicator of compromise (IoC) in computer forensics. This is an artifact observed on a network or in an operating system that, with high confidence, indicates a computer intrusion. Reference: https://en.wikipedia.org/wiki/Indicator_of_compromise" }, + "kubernetes": { + "$ref": "Kubernetes", + "description": "Kubernetes resources associated with the finding." + }, "mitreAttack": { "$ref": "MitreAttack", "description": "MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org" @@ -1753,6 +1825,32 @@ }, "type": "object" }, + "GoogleCloudSecuritycenterV1Binding": { + "description": "Represents a Kubernetes RoleBinding or ClusterRoleBinding.", + "id": "GoogleCloudSecuritycenterV1Binding", + "properties": { + "name": { + "description": "Name for binding.", + "type": "string" + }, + "ns": { + "description": "Namespace for binding.", + "type": "string" + }, + "role": { + "$ref": "Role", + "description": "The Role or ClusterRole referenced by the binding." + }, + "subjects": { + "description": "Represents the subjects(s) bound to the role. Not always available for PATCH requests.", + "items": { + "$ref": "Subject" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudSecuritycenterV1BulkMuteFindingsResponse": { "description": "The response to a BulkMute request. Contains the LRO information.", "id": "GoogleCloudSecuritycenterV1BulkMuteFindingsResponse", @@ -2418,6 +2516,70 @@ }, "type": "object" }, + "Kubernetes": { + "description": "Kubernetes related attributes.", + "id": "Kubernetes", + "properties": { + "accessReviews": { + "description": "Provides information on any Kubernetes access reviews (i.e. privilege checks) relevant to the finding.", + "items": { + "$ref": "AccessReview" + }, + "type": "array" + }, + "bindings": { + "description": "Provides Kubernetes role binding information for findings that involve RoleBindings or ClusterRoleBindings.", + "items": { + "$ref": "GoogleCloudSecuritycenterV1Binding" + }, + "type": "array" + }, + "nodePools": { + "description": "GKE Node Pools associated with the finding. This field will contain NodePool information for each Node, when it is available.", + "items": { + "$ref": "NodePool" + }, + "type": "array" + }, + "nodes": { + "description": "Provides Kubernetes Node information.", + "items": { + "$ref": "Node" + }, + "type": "array" + }, + "pods": { + "description": "Kubernetes Pods associated with the finding. This field will contain Pod records for each container that is owned by a Pod.", + "items": { + "$ref": "Pod" + }, + "type": "array" + }, + "roles": { + "description": "Provides Kubernetes role information for findings that involve Roles or ClusterRoles.", + "items": { + "$ref": "Role" + }, + "type": "array" + } + }, + "type": "object" + }, + "Label": { + "description": "Label represents a generic name=value label. Label has separate name and value fields to support filtering with contains().", + "id": "Label", + "properties": { + "name": { + "description": "Label name.", + "type": "string" + }, + "value": { + "description": "Label value.", + "type": "string" + } + }, + "type": "object" + }, "ListAssetsResponse": { "description": "Response message for listing assets.", "id": "ListAssetsResponse", @@ -2637,7 +2799,8 @@ "MODIFY_AUTHENTICATION_PROCESS", "DATA_DESTRUCTION", "DOMAIN_POLICY_MODIFICATION", - "IMPAIR_DEFENSES" + "IMPAIR_DEFENSES", + "NETWORK_SERVICE_DISCOVERY" ], "enumDescriptions": [ "Unspecified value.", @@ -2671,7 +2834,8 @@ "T1556", "T1485", "T1484", - "T1562" + "T1562", + "T1046" ], "type": "string" }, @@ -2750,7 +2914,8 @@ "MODIFY_AUTHENTICATION_PROCESS", "DATA_DESTRUCTION", "DOMAIN_POLICY_MODIFICATION", - "IMPAIR_DEFENSES" + "IMPAIR_DEFENSES", + "NETWORK_SERVICE_DISCOVERY" ], "enumDescriptions": [ "Unspecified value.", @@ -2784,7 +2949,8 @@ "T1556", "T1485", "T1484", - "T1562" + "T1562", + "T1046" ], "type": "string" }, @@ -2797,6 +2963,35 @@ }, "type": "object" }, + "Node": { + "description": "Kubernetes Nodes associated with the finding.", + "id": "Node", + "properties": { + "name": { + "description": "Full Resource name of the Compute Engine VM running the cluster node.", + "type": "string" + } + }, + "type": "object" + }, + "NodePool": { + "description": "Provides GKE Node Pool information.", + "id": "NodePool", + "properties": { + "name": { + "description": "Kubernetes Node pool name.", + "type": "string" + }, + "nodes": { + "description": "Nodes associated with the finding.", + "items": { + "$ref": "Node" + }, + "type": "array" + } + }, + "type": "object" + }, "Operation": { "description": "This resource represents a long-running operation that is the result of a network API call.", "id": "Operation", @@ -2851,6 +3046,35 @@ }, "type": "object" }, + "Pod": { + "description": "Kubernetes Pod.", + "id": "Pod", + "properties": { + "containers": { + "description": "Pod containers associated with this finding, if any.", + "items": { + "$ref": "Container" + }, + "type": "array" + }, + "labels": { + "description": "Pod labels. For Kubernetes containers, these are applied to the container.", + "items": { + "$ref": "Label" + }, + "type": "array" + }, + "name": { + "description": "Kubernetes Pod name.", + "type": "string" + }, + "ns": { + "description": "Kubernetes Pod namespace.", + "type": "string" + } + }, + "type": "object" + }, "Policy": { "description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).", "id": "Policy", @@ -2970,6 +3194,35 @@ }, "type": "object" }, + "Role": { + "description": "Kubernetes Role or ClusterRole.", + "id": "Role", + "properties": { + "kind": { + "description": "Role type.", + "enum": [ + "KIND_UNSPECIFIED", + "ROLE", + "CLUSTER_ROLE" + ], + "enumDescriptions": [ + "Role type is not specified.", + "Kubernetes Role.", + "Kubernetes ClusterRole." + ], + "type": "string" + }, + "name": { + "description": "Role name.", + "type": "string" + }, + "ns": { + "description": "Role namespace.", + "type": "string" + } + }, + "type": "object" + }, "RunAssetDiscoveryRequest": { "description": "Request message for running asset discovery for an organization.", "id": "RunAssetDiscoveryRequest", @@ -3116,6 +3369,37 @@ }, "type": "object" }, + "Subject": { + "description": "Represents a Kubernetes Subject.", + "id": "Subject", + "properties": { + "kind": { + "description": "Authentication type for subject.", + "enum": [ + "AUTH_TYPE_UNSPECIFIED", + "USER", + "SERVICEACCOUNT", + "GROUP" + ], + "enumDescriptions": [ + "Authentication is not specified.", + "User with valid certificate.", + "Users managed by Kubernetes API with credentials stored as Secrets.", + "Collection of users." + ], + "type": "string" + }, + "name": { + "description": "Name for subject.", + "type": "string" + }, + "ns": { + "description": "Namespace for subject.", + "type": "string" + } + }, + "type": "object" + }, "TestIamPermissionsRequest": { "description": "Request message for `TestIamPermissions` method.", "id": "TestIamPermissionsRequest", diff --git a/googleapiclient/discovery_cache/documents/securitycenter.v1beta2.json b/googleapiclient/discovery_cache/documents/securitycenter.v1beta2.json index 44161036522..8c7af9d4c01 100644 --- a/googleapiclient/discovery_cache/documents/securitycenter.v1beta2.json +++ b/googleapiclient/discovery_cache/documents/securitycenter.v1beta2.json @@ -1981,7 +1981,7 @@ } } }, - "revision": "20220707", + "revision": "20220713", "rootUrl": "https://securitycenter.googleapis.com/", "schemas": { "Access": { @@ -2015,6 +2015,41 @@ }, "type": "object" }, + "AccessReview": { + "description": "Conveys information about a Kubernetes access review (e.g. kubectl auth can-i ...) that was involved in a finding.", + "id": "AccessReview", + "properties": { + "group": { + "description": "Group is the API Group of the Resource. \"*\" means all.", + "type": "string" + }, + "name": { + "description": "Name is the name of the resource being requested. Empty means all.", + "type": "string" + }, + "ns": { + "description": "Namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces. Both are represented by \"\" (empty).", + "type": "string" + }, + "resource": { + "description": "Resource is the optional resource type requested. \"*\" means all.", + "type": "string" + }, + "subresource": { + "description": "Subresource is the optional subresource type.", + "type": "string" + }, + "verb": { + "description": "Verb is a Kubernetes resource API verb, like: get, list, watch, create, update, delete, proxy. \"*\" means all.", + "type": "string" + }, + "version": { + "description": "Version is the API Version of the Resource. \"*\" means all.", + "type": "string" + } + }, + "type": "object" + }, "Compliance": { "description": "Contains compliance information about a security standard indicating unmet recommendations.", "id": "Compliance", @@ -2138,6 +2173,32 @@ }, "type": "object" }, + "Container": { + "description": "Container associated with the finding.", + "id": "Container", + "properties": { + "imageId": { + "description": "Optional container image id, when provided by the container runtime. Uniquely identifies the container image launched using a container image digest.", + "type": "string" + }, + "labels": { + "description": "Container labels, as provided by the container runtime.", + "items": { + "$ref": "Label" + }, + "type": "array" + }, + "name": { + "description": "Container name.", + "type": "string" + }, + "uri": { + "description": "Container image URI provided when configuring a pod/container. May identify a container image version using mutable tags.", + "type": "string" + } + }, + "type": "object" + }, "ContainerThreatDetectionSettings": { "description": "Resource capturing the settings for the Container Threat Detection service.", "id": "ContainerThreatDetectionSettings", @@ -2557,10 +2618,17 @@ "additionalProperties": { "$ref": "ContactDetails" }, - "description": "Output only. Map containing the point of contacts for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { \"security\":[ { \"contact\":{ \"email\":\"person1@company.com\" } }, { \"contact\":{ \"email\":\u201cperson2@company.com\u201d } } ] }", + "description": "Output only. Map containing the point of contacts for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories { \"security\": { \"contacts\": [ { \"email\": \"person1@company.com\" }, { \"email\": \"person2@company.com\" } ] }", "readOnly": true, "type": "object" }, + "containers": { + "description": "Containers associated with the finding. containers provides information for both Kubernetes and non-Kubernetes containers.", + "items": { + "$ref": "Container" + }, + "type": "array" + }, "createTime": { "description": "The time at which the finding was created in Security Command Center.", "format": "google-datetime", @@ -2622,6 +2690,10 @@ "$ref": "Indicator", "description": "Represents what's commonly known as an Indicator of compromise (IoC) in computer forensics. This is an artifact observed on a network or in an operating system that, with high confidence, indicates a computer intrusion. Reference: https://en.wikipedia.org/wiki/Indicator_of_compromise" }, + "kubernetes": { + "$ref": "Kubernetes", + "description": "Kubernetes resources associated with the finding." + }, "mitreAttack": { "$ref": "MitreAttack", "description": "MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org" @@ -2797,6 +2869,32 @@ }, "type": "object" }, + "GoogleCloudSecuritycenterV1Binding": { + "description": "Represents a Kubernetes RoleBinding or ClusterRoleBinding.", + "id": "GoogleCloudSecuritycenterV1Binding", + "properties": { + "name": { + "description": "Name for binding.", + "type": "string" + }, + "ns": { + "description": "Namespace for binding.", + "type": "string" + }, + "role": { + "$ref": "Role", + "description": "The Role or ClusterRole referenced by the binding." + }, + "subjects": { + "description": "Represents the subjects(s) bound to the role. Not always available for PATCH requests.", + "items": { + "$ref": "Subject" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudSecuritycenterV1BulkMuteFindingsResponse": { "description": "The response to a BulkMute request. Contains the LRO information.", "id": "GoogleCloudSecuritycenterV1BulkMuteFindingsResponse", @@ -3253,6 +3351,70 @@ }, "type": "object" }, + "Kubernetes": { + "description": "Kubernetes related attributes.", + "id": "Kubernetes", + "properties": { + "accessReviews": { + "description": "Provides information on any Kubernetes access reviews (i.e. privilege checks) relevant to the finding.", + "items": { + "$ref": "AccessReview" + }, + "type": "array" + }, + "bindings": { + "description": "Provides Kubernetes role binding information for findings that involve RoleBindings or ClusterRoleBindings.", + "items": { + "$ref": "GoogleCloudSecuritycenterV1Binding" + }, + "type": "array" + }, + "nodePools": { + "description": "GKE Node Pools associated with the finding. This field will contain NodePool information for each Node, when it is available.", + "items": { + "$ref": "NodePool" + }, + "type": "array" + }, + "nodes": { + "description": "Provides Kubernetes Node information.", + "items": { + "$ref": "Node" + }, + "type": "array" + }, + "pods": { + "description": "Kubernetes Pods associated with the finding. This field will contain Pod records for each container that is owned by a Pod.", + "items": { + "$ref": "Pod" + }, + "type": "array" + }, + "roles": { + "description": "Provides Kubernetes role information for findings that involve Roles or ClusterRoles.", + "items": { + "$ref": "Role" + }, + "type": "array" + } + }, + "type": "object" + }, + "Label": { + "description": "Label represents a generic name=value label. Label has separate name and value fields to support filtering with contains().", + "id": "Label", + "properties": { + "name": { + "description": "Label name.", + "type": "string" + }, + "value": { + "description": "Label value.", + "type": "string" + } + }, + "type": "object" + }, "MemoryHashSignature": { "description": "A signature corresponding to memory page hashes.", "id": "MemoryHashSignature", @@ -3351,7 +3513,8 @@ "MODIFY_AUTHENTICATION_PROCESS", "DATA_DESTRUCTION", "DOMAIN_POLICY_MODIFICATION", - "IMPAIR_DEFENSES" + "IMPAIR_DEFENSES", + "NETWORK_SERVICE_DISCOVERY" ], "enumDescriptions": [ "Unspecified value.", @@ -3385,7 +3548,8 @@ "T1556", "T1485", "T1484", - "T1562" + "T1562", + "T1046" ], "type": "string" }, @@ -3464,7 +3628,8 @@ "MODIFY_AUTHENTICATION_PROCESS", "DATA_DESTRUCTION", "DOMAIN_POLICY_MODIFICATION", - "IMPAIR_DEFENSES" + "IMPAIR_DEFENSES", + "NETWORK_SERVICE_DISCOVERY" ], "enumDescriptions": [ "Unspecified value.", @@ -3498,7 +3663,8 @@ "T1556", "T1485", "T1484", - "T1562" + "T1562", + "T1046" ], "type": "string" }, @@ -3511,6 +3677,35 @@ }, "type": "object" }, + "Node": { + "description": "Kubernetes Nodes associated with the finding.", + "id": "Node", + "properties": { + "name": { + "description": "Full Resource name of the Compute Engine VM running the cluster node.", + "type": "string" + } + }, + "type": "object" + }, + "NodePool": { + "description": "Provides GKE Node Pool information.", + "id": "NodePool", + "properties": { + "name": { + "description": "Kubernetes Node pool name.", + "type": "string" + }, + "nodes": { + "description": "Nodes associated with the finding.", + "items": { + "$ref": "Node" + }, + "type": "array" + } + }, + "type": "object" + }, "OnboardingState": { "description": "Resource capturing onboarding information for a given CRM resource.", "id": "OnboardingState", @@ -3536,6 +3731,35 @@ }, "type": "object" }, + "Pod": { + "description": "Kubernetes Pod.", + "id": "Pod", + "properties": { + "containers": { + "description": "Pod containers associated with this finding, if any.", + "items": { + "$ref": "Container" + }, + "type": "array" + }, + "labels": { + "description": "Pod labels. For Kubernetes containers, these are applied to the container.", + "items": { + "$ref": "Label" + }, + "type": "array" + }, + "name": { + "description": "Kubernetes Pod name.", + "type": "string" + }, + "ns": { + "description": "Kubernetes Pod namespace.", + "type": "string" + } + }, + "type": "object" + }, "Process": { "description": "Represents an operating system process.", "id": "Process", @@ -3664,12 +3888,41 @@ }, "type": "object" }, + "Role": { + "description": "Kubernetes Role or ClusterRole.", + "id": "Role", + "properties": { + "kind": { + "description": "Role type.", + "enum": [ + "KIND_UNSPECIFIED", + "ROLE", + "CLUSTER_ROLE" + ], + "enumDescriptions": [ + "Role type is not specified.", + "Kubernetes Role.", + "Kubernetes ClusterRole." + ], + "type": "string" + }, + "name": { + "description": "Role name.", + "type": "string" + }, + "ns": { + "description": "Role namespace.", + "type": "string" + } + }, + "type": "object" + }, "SecurityCenterSettings": { "description": "Resource capturing the settings for Security Center.", "id": "SecurityCenterSettings", "properties": { "logSinkProject": { - "description": "The resource name of the project to send logs to. This project must be part of the organization this resource resides in. The format is `projects/{project_id}`. An empty value disables logging. This value is only referenced by services that support log sink. Please refer to the documentation for an updated list of compatible services.", + "description": "The resource name of the project to send logs to. This project must be part of the organization this resource resides in. The format is `projects/{project_id}`. An empty value disables logging. This value is only referenced by services that support log sink. Please refer to the documentation for an updated list of compatible services. This may only be specified for organization level onboarding.", "type": "string" }, "name": { @@ -3677,12 +3930,14 @@ "type": "string" }, "onboardingTime": { - "description": "Timestamp of when the customer organization was onboarded to SCC.", + "description": "Output only. Timestamp of when the customer organization was onboarded to SCC.", "format": "google-datetime", + "readOnly": true, "type": "string" }, "orgServiceAccount": { - "description": "The organization level service account to be used for security center components.", + "description": "Output only. The organization level service account to be used for security center components.", + "readOnly": true, "type": "string" } }, @@ -3755,6 +4010,37 @@ }, "type": "object" }, + "Subject": { + "description": "Represents a Kubernetes Subject.", + "id": "Subject", + "properties": { + "kind": { + "description": "Authentication type for subject.", + "enum": [ + "AUTH_TYPE_UNSPECIFIED", + "USER", + "SERVICEACCOUNT", + "GROUP" + ], + "enumDescriptions": [ + "Authentication is not specified.", + "User with valid certificate.", + "Users managed by Kubernetes API with credentials stored as Secrets.", + "Collection of users." + ], + "type": "string" + }, + "name": { + "description": "Name for subject.", + "type": "string" + }, + "ns": { + "description": "Namespace for subject.", + "type": "string" + } + }, + "type": "object" + }, "Subscription": { "description": "Resource capturing the state of an organization's subscription.", "id": "Subscription", From bd1e2e47f90ed83daf4e6665684619d6e641a036 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 19 Jul 2022 07:08:15 +0000 Subject: [PATCH 21/23] feat(servicenetworking): update the api #### servicenetworking:v1 The following keys were added: - schemas.CloudSQLConfig (Total Keys: 6) - schemas.ConsumerConfig.properties.cloudsqlConfigs (Total Keys: 2) #### servicenetworking:v1beta The following keys were added: - schemas.CloudSQLConfig (Total Keys: 6) - schemas.ConsumerConfig.properties.cloudsqlConfigs (Total Keys: 2) --- ...v1.services.projects.global_.networks.html | 14 +++++++++ .../documents/servicenetworking.v1.json | 29 ++++++++++++++++++- .../documents/servicenetworking.v1beta.json | 29 ++++++++++++++++++- 3 files changed, 70 insertions(+), 2 deletions(-) diff --git a/docs/dyn/servicenetworking_v1.services.projects.global_.networks.html b/docs/dyn/servicenetworking_v1.services.projects.global_.networks.html index f984f443da1..00c3d5e1601 100644 --- a/docs/dyn/servicenetworking_v1.services.projects.global_.networks.html +++ b/docs/dyn/servicenetworking_v1.services.projects.global_.networks.html @@ -110,6 +110,13 @@

Method Details

An object of the form: { # Configuration information for a private service access connection. + "cloudsqlConfigs": [ # Represents one or multiple Cloud SQL configurations. + { # Cloud SQL configuration. + "service": "A String", # Peering service used for peering with the Cloud SQL project. + "umbrellaNetwork": "A String", # The name of network in Cloud SQL umbrella project. + "umbrellaProject": "A String", # The project number of Cloud SQL umbrella project. + }, + ], "consumerExportCustomRoutes": True or False, # Export custom routes flag value for peering from consumer to producer. "consumerExportSubnetRoutesWithPublicIp": True or False, # Export subnet routes with public ip flag value for peering from consumer to producer. "consumerImportCustomRoutes": True or False, # Import custom routes flag value for peering from consumer to producer. @@ -144,6 +151,13 @@

Method Details

{ # Request to update the configuration of a service networking connection including the import/export of custom routes and subnetwork routes with public IP. "consumerConfig": { # Configuration information for a private service access connection. # Required. The updated peering config. + "cloudsqlConfigs": [ # Represents one or multiple Cloud SQL configurations. + { # Cloud SQL configuration. + "service": "A String", # Peering service used for peering with the Cloud SQL project. + "umbrellaNetwork": "A String", # The name of network in Cloud SQL umbrella project. + "umbrellaProject": "A String", # The project number of Cloud SQL umbrella project. + }, + ], "consumerExportCustomRoutes": True or False, # Export custom routes flag value for peering from consumer to producer. "consumerExportSubnetRoutesWithPublicIp": True or False, # Export subnet routes with public ip flag value for peering from consumer to producer. "consumerImportCustomRoutes": True or False, # Import custom routes flag value for peering from consumer to producer. diff --git a/googleapiclient/discovery_cache/documents/servicenetworking.v1.json b/googleapiclient/discovery_cache/documents/servicenetworking.v1.json index 96e1650e461..488bfaa7a54 100644 --- a/googleapiclient/discovery_cache/documents/servicenetworking.v1.json +++ b/googleapiclient/discovery_cache/documents/servicenetworking.v1.json @@ -865,7 +865,7 @@ } } }, - "revision": "20220706", + "revision": "20220712", "rootUrl": "https://servicenetworking.googleapis.com/", "schemas": { "AddDnsRecordSetMetadata": { @@ -1303,6 +1303,26 @@ "properties": {}, "type": "object" }, + "CloudSQLConfig": { + "description": "Cloud SQL configuration.", + "id": "CloudSQLConfig", + "properties": { + "service": { + "description": "Peering service used for peering with the Cloud SQL project.", + "type": "string" + }, + "umbrellaNetwork": { + "description": "The name of network in Cloud SQL umbrella project.", + "type": "string" + }, + "umbrellaProject": { + "description": "The project number of Cloud SQL umbrella project.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, "Connection": { "description": "Represents a private connection resource. A private connection is implemented as a VPC Network Peering connection between a service producer's VPC network and a service consumer's VPC network.", "id": "Connection", @@ -1335,6 +1355,13 @@ "description": "Configuration information for a private service access connection.", "id": "ConsumerConfig", "properties": { + "cloudsqlConfigs": { + "description": "Represents one or multiple Cloud SQL configurations.", + "items": { + "$ref": "CloudSQLConfig" + }, + "type": "array" + }, "consumerExportCustomRoutes": { "description": "Export custom routes flag value for peering from consumer to producer.", "type": "boolean" diff --git a/googleapiclient/discovery_cache/documents/servicenetworking.v1beta.json b/googleapiclient/discovery_cache/documents/servicenetworking.v1beta.json index e68c0863a45..af1192326f5 100644 --- a/googleapiclient/discovery_cache/documents/servicenetworking.v1beta.json +++ b/googleapiclient/discovery_cache/documents/servicenetworking.v1beta.json @@ -307,7 +307,7 @@ } } }, - "revision": "20220706", + "revision": "20220712", "rootUrl": "https://servicenetworking.googleapis.com/", "schemas": { "AddDnsRecordSetMetadata": { @@ -644,6 +644,26 @@ }, "type": "object" }, + "CloudSQLConfig": { + "description": "Cloud SQL configuration.", + "id": "CloudSQLConfig", + "properties": { + "service": { + "description": "Peering service used for peering with the Cloud SQL project.", + "type": "string" + }, + "umbrellaNetwork": { + "description": "The name of network in Cloud SQL umbrella project.", + "type": "string" + }, + "umbrellaProject": { + "description": "The project number of Cloud SQL umbrella project.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, "Connection": { "description": "Represents a private connection resource. A private connection is implemented as a VPC Network Peering connection between a service producer's VPC network and a service consumer's VPC network.", "id": "Connection", @@ -676,6 +696,13 @@ "description": "Configuration information for a private service access connection.", "id": "ConsumerConfig", "properties": { + "cloudsqlConfigs": { + "description": "Represents one or multiple Cloud SQL configurations.", + "items": { + "$ref": "CloudSQLConfig" + }, + "type": "array" + }, "consumerExportCustomRoutes": { "description": "Export custom routes flag value for peering from consumer to producer.", "type": "boolean" From e344e6f08ebcef5a5a3139ffda9e2cd86eaa78b8 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 19 Jul 2022 07:08:16 +0000 Subject: [PATCH 22/23] feat(youtube): update the api #### youtube:v3 The following keys were deleted: - resources.liveBroadcasts.methods.insertCuepoint.parameters.resource.cueType (Total Keys: 2) - resources.liveBroadcasts.methods.insertCuepoint.parameters.resource.durationSecs (Total Keys: 3) - resources.liveBroadcasts.methods.insertCuepoint.parameters.resource.id (Total Keys: 2) - resources.liveBroadcasts.methods.insertCuepoint.parameters.resource.insertionOffsetTimeMs (Total Keys: 3) - resources.liveBroadcasts.methods.insertCuepoint.parameters.resource.walltimeMs (Total Keys: 3) The following keys were added: - resources.liveBroadcasts.methods.insertCuepoint.request.$ref (Total Keys: 1) - resources.liveBroadcasts.methods.insertCuepoint.scopes (Total Keys: 1) --- docs/dyn/youtube_v3.liveBroadcasts.html | 25 +++++---- docs/dyn/youtube_v3.videos.html | 10 ++-- .../discovery_cache/documents/youtube.v3.json | 51 ++++--------------- 3 files changed, 28 insertions(+), 58 deletions(-) diff --git a/docs/dyn/youtube_v3.liveBroadcasts.html b/docs/dyn/youtube_v3.liveBroadcasts.html index 3f06cbc1e74..f099f682f55 100644 --- a/docs/dyn/youtube_v3.liveBroadcasts.html +++ b/docs/dyn/youtube_v3.liveBroadcasts.html @@ -87,7 +87,7 @@

Instance Methods

insert(part, body=None, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None, x__xgafv=None)

Inserts a new stream for the authenticated user.

- insertCuepoint(id=None, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None, part=None, resource_cueType=None, resource_durationSecs=None, resource_etag=None, resource_id=None, resource_insertionOffsetTimeMs=None, resource_walltimeMs=None, x__xgafv=None)

+ insertCuepoint(body=None, id=None, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None, part=None, x__xgafv=None)

Insert cuepoints in a broadcast

list(part, broadcastStatus=None, broadcastType=None, id=None, maxResults=None, mine=None, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None, pageToken=None, x__xgafv=None)

@@ -399,23 +399,26 @@

Method Details

- insertCuepoint(id=None, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None, part=None, resource_cueType=None, resource_durationSecs=None, resource_etag=None, resource_id=None, resource_insertionOffsetTimeMs=None, resource_walltimeMs=None, x__xgafv=None) + insertCuepoint(body=None, id=None, onBehalfOfContentOwner=None, onBehalfOfContentOwnerChannel=None, part=None, x__xgafv=None)
Insert cuepoints in a broadcast
 
 Args:
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Note that there may be a 5-second end-point resolution issue. For instance, if a cuepoint comes in for 22:03:27, we may stuff the cuepoint into 22:03:25 or 22:03:30, depending. This is an artifact of HLS.
+  "cueType": "A String",
+  "durationSecs": 42, # The duration of this cuepoint.
+  "etag": "A String",
+  "id": "A String", # The identifier for cuepoint resource.
+  "insertionOffsetTimeMs": "A String", # The time when the cuepoint should be inserted by offset to the broadcast actual start time.
+  "walltimeMs": "A String", # The wall clock time at which the cuepoint should be inserted. Only one of insertion_offset_time_ms and walltime_ms may be set at a time.
+}
+
   id: string, Broadcast to insert ads to, or equivalently `external_video_id` for internal use.
   onBehalfOfContentOwner: string, *Note:* This parameter is intended exclusively for YouTube content partners. The *onBehalfOfContentOwner* parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner.
   onBehalfOfContentOwnerChannel: string, This parameter can only be used in a properly authorized request. *Note:* This parameter is intended exclusively for YouTube content partners. The *onBehalfOfContentOwnerChannel* parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel.
   part: string, The *part* parameter specifies a comma-separated list of one or more liveBroadcast resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, contentDetails, and status. (repeated)
-  resource_cueType: string, A parameter
-    Allowed values
-      cueTypeUnspecified - 
-      cueTypeAd - 
-  resource_durationSecs: integer, The duration of this cuepoint.
-  resource_etag: string, A parameter
-  resource_id: string, The identifier for cuepoint resource.
-  resource_insertionOffsetTimeMs: string, The time when the cuepoint should be inserted by offset to the broadcast actual start time.
-  resource_walltimeMs: string, The wall clock time at which the cuepoint should be inserted. Only one of insertion_offset_time_ms and walltime_ms may be set at a time.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
diff --git a/docs/dyn/youtube_v3.videos.html b/docs/dyn/youtube_v3.videos.html
index b1c69fe55f8..60567181de6 100644
--- a/docs/dyn/youtube_v3.videos.html
+++ b/docs/dyn/youtube_v3.videos.html
@@ -401,7 +401,7 @@ 

Method Details

"likeCount": "A String", # The number of users who have indicated that they liked the video by giving it a positive rating. "viewCount": "A String", # The number of times the video has been viewed. }, - "status": { # Basic details about a video category, such as its localized title. Next Id: 17 # The status object contains information about the video's uploading, processing, and privacy statuses. + "status": { # Basic details about a video category, such as its localized title. Next Id: 18 # The status object contains information about the video's uploading, processing, and privacy statuses. "embeddable": True or False, # This value indicates if the video can be embedded on another website. @mutable youtube.videos.insert youtube.videos.update "failureReason": "A String", # This value explains why a video failed to upload. This property is only present if the uploadStatus property indicates that the upload failed. "license": "A String", # The video's license. @mutable youtube.videos.insert youtube.videos.update @@ -705,7 +705,7 @@

Method Details

"likeCount": "A String", # The number of users who have indicated that they liked the video by giving it a positive rating. "viewCount": "A String", # The number of times the video has been viewed. }, - "status": { # Basic details about a video category, such as its localized title. Next Id: 17 # The status object contains information about the video's uploading, processing, and privacy statuses. + "status": { # Basic details about a video category, such as its localized title. Next Id: 18 # The status object contains information about the video's uploading, processing, and privacy statuses. "embeddable": True or False, # This value indicates if the video can be embedded on another website. @mutable youtube.videos.insert youtube.videos.update "failureReason": "A String", # This value explains why a video failed to upload. This property is only present if the uploadStatus property indicates that the upload failed. "license": "A String", # The video's license. @mutable youtube.videos.insert youtube.videos.update @@ -1032,7 +1032,7 @@

Method Details

"likeCount": "A String", # The number of users who have indicated that they liked the video by giving it a positive rating. "viewCount": "A String", # The number of times the video has been viewed. }, - "status": { # Basic details about a video category, such as its localized title. Next Id: 17 # The status object contains information about the video's uploading, processing, and privacy statuses. + "status": { # Basic details about a video category, such as its localized title. Next Id: 18 # The status object contains information about the video's uploading, processing, and privacy statuses. "embeddable": True or False, # This value indicates if the video can be embedded on another website. @mutable youtube.videos.insert youtube.videos.update "failureReason": "A String", # This value explains why a video failed to upload. This property is only present if the uploadStatus property indicates that the upload failed. "license": "A String", # The video's license. @mutable youtube.videos.insert youtube.videos.update @@ -1399,7 +1399,7 @@

Method Details

"likeCount": "A String", # The number of users who have indicated that they liked the video by giving it a positive rating. "viewCount": "A String", # The number of times the video has been viewed. }, - "status": { # Basic details about a video category, such as its localized title. Next Id: 17 # The status object contains information about the video's uploading, processing, and privacy statuses. + "status": { # Basic details about a video category, such as its localized title. Next Id: 18 # The status object contains information about the video's uploading, processing, and privacy statuses. "embeddable": True or False, # This value indicates if the video can be embedded on another website. @mutable youtube.videos.insert youtube.videos.update "failureReason": "A String", # This value explains why a video failed to upload. This property is only present if the uploadStatus property indicates that the upload failed. "license": "A String", # The video's license. @mutable youtube.videos.insert youtube.videos.update @@ -1697,7 +1697,7 @@

Method Details

"likeCount": "A String", # The number of users who have indicated that they liked the video by giving it a positive rating. "viewCount": "A String", # The number of times the video has been viewed. }, - "status": { # Basic details about a video category, such as its localized title. Next Id: 17 # The status object contains information about the video's uploading, processing, and privacy statuses. + "status": { # Basic details about a video category, such as its localized title. Next Id: 18 # The status object contains information about the video's uploading, processing, and privacy statuses. "embeddable": True or False, # This value indicates if the video can be embedded on another website. @mutable youtube.videos.insert youtube.videos.update "failureReason": "A String", # This value explains why a video failed to upload. This property is only present if the uploadStatus property indicates that the upload failed. "license": "A String", # The video's license. @mutable youtube.videos.insert youtube.videos.update diff --git a/googleapiclient/discovery_cache/documents/youtube.v3.json b/googleapiclient/discovery_cache/documents/youtube.v3.json index 167c0ba80fa..a5d80a175fc 100644 --- a/googleapiclient/discovery_cache/documents/youtube.v3.json +++ b/googleapiclient/discovery_cache/documents/youtube.v3.json @@ -1406,51 +1406,18 @@ "location": "query", "repeated": true, "type": "string" - }, - "resource.cueType": { - "enum": [ - "cueTypeUnspecified", - "cueTypeAd" - ], - "enumDescriptions": [ - "", - "" - ], - "location": "query", - "type": "string" - }, - "resource.durationSecs": { - "description": "The duration of this cuepoint.", - "format": "uint32", - "location": "query", - "type": "integer" - }, - "resource.etag": { - "location": "query", - "type": "string" - }, - "resource.id": { - "description": "The identifier for cuepoint resource.", - "location": "query", - "type": "string" - }, - "resource.insertionOffsetTimeMs": { - "description": "The time when the cuepoint should be inserted by offset to the broadcast actual start time.", - "format": "int64", - "location": "query", - "type": "string" - }, - "resource.walltimeMs": { - "description": "The wall clock time at which the cuepoint should be inserted. Only one of insertion_offset_time_ms and walltime_ms may be set at a time.", - "format": "uint64", - "location": "query", - "type": "string" } }, "path": "youtube/v3/liveBroadcasts/cuepoint", + "request": { + "$ref": "Cuepoint" + }, "response": { "$ref": "Cuepoint" - } + }, + "scopes": [ + "https://www.googleapis.com/auth/youtubepartner" + ] }, "list": { "description": "Retrieve the list of broadcasts associated with the given channel.", @@ -3862,7 +3829,7 @@ } } }, - "revision": "20220710", + "revision": "20220716", "rootUrl": "https://youtube.googleapis.com/", "schemas": { "AbuseReport": { @@ -11377,7 +11344,7 @@ "type": "object" }, "VideoStatus": { - "description": "Basic details about a video category, such as its localized title. Next Id: 17", + "description": "Basic details about a video category, such as its localized title. Next Id: 18", "id": "VideoStatus", "properties": { "embeddable": { From c40111ddfa44b0f7b0d1c6b8489ab17ee921bfff Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 19 Jul 2022 07:08:17 +0000 Subject: [PATCH 23/23] chore(docs): Add new discovery artifacts and artifacts with minor updates --- ...ement_v1.enterprises.enrollmentTokens.html | 8 +- .../apigee_v1.organizations.apiproducts.html | 28 +- .../apigee_v1.organizations.environments.html | 4 +- ...v1.projects.locations.transferConfigs.html | 12 +- ...atransfer_v1.projects.transferConfigs.html | 12 +- docs/dyn/chat_v1.dms.conversations.html | 4 +- docs/dyn/chat_v1.dms.html | 8 +- docs/dyn/chat_v1.rooms.conversations.html | 4 +- docs/dyn/chat_v1.rooms.html | 8 +- docs/dyn/chat_v1.spaces.html | 4 +- docs/dyn/chat_v1.spaces.messages.html | 10 +- .../dyn/cloudresourcemanager_v1.projects.html | 2 +- ...cloudresourcemanager_v1beta1.projects.html | 2 +- .../dyn/cloudresourcemanager_v3.projects.html | 2 +- ...alogflow_v3.projects.locations.agents.html | 12 +- ...low_v3beta1.projects.locations.agents.html | 12 +- ...dlp_v2.organizations.inspectTemplates.html | 48 +- ...lp_v2.organizations.locations.dlpJobs.html | 16 +- ...anizations.locations.inspectTemplates.html | 48 +- ...2.organizations.locations.jobTriggers.html | 48 +- docs/dyn/dlp_v2.projects.content.html | 24 +- docs/dyn/dlp_v2.projects.dlpJobs.html | 56 +- docs/dyn/dlp_v2.projects.image.html | 8 +- .../dyn/dlp_v2.projects.inspectTemplates.html | 48 +- docs/dyn/dlp_v2.projects.jobTriggers.html | 64 +-- .../dlp_v2.projects.locations.content.html | 24 +- .../dlp_v2.projects.locations.dlpJobs.html | 56 +- docs/dyn/dlp_v2.projects.locations.image.html | 8 +- ...2.projects.locations.inspectTemplates.html | 48 +- ...dlp_v2.projects.locations.jobTriggers.html | 64 +-- ...s_v1.projects.locations.registrations.html | 66 +-- ...pha2.projects.locations.registrations.html | 66 +-- ...eta1.projects.locations.registrations.html | 66 +-- .../dyn/doubleclickbidmanager_v2.queries.html | 130 ++--- ...bleclickbidmanager_v2.queries.reports.html | 48 +- ..._v1beta1.projects.databases.documents.html | 516 ++++++++++-------- .../dyn/logging_v2.billingAccounts.sinks.html | 16 +- docs/dyn/logging_v2.entries.html | 12 +- docs/dyn/logging_v2.folders.sinks.html | 16 +- docs/dyn/logging_v2.organizations.sinks.html | 16 +- docs/dyn/logging_v2.projects.sinks.html | 16 +- docs/dyn/logging_v2.sinks.html | 12 +- ...jects.locations.authorizationPolicies.html | 24 +- ....projects.locations.clientTlsPolicies.html | 16 +- ....projects.locations.serverTlsPolicies.html | 16 +- ...jects.locations.authorizationPolicies.html | 24 +- ....projects.locations.clientTlsPolicies.html | 16 +- ....projects.locations.serverTlsPolicies.html | 16 +- docs/dyn/webrisk_v1.hashes.html | 2 +- docs/dyn/webrisk_v1.threatLists.html | 2 +- docs/dyn/webrisk_v1.uris.html | 2 +- .../acceleratedmobilepageurl.v1.json | 2 +- .../documents/accessapproval.v1.json | 2 +- .../documents/accesscontextmanager.v1.json | 2 +- .../accesscontextmanager.v1beta.json | 2 +- .../documents/adexchangebuyer2.v2beta1.json | 2 +- .../documents/admin.datatransfer_v1.json | 2 +- .../documents/admin.directory_v1.json | 2 +- .../documents/admin.reports_v1.json | 2 +- .../discovery_cache/documents/admob.v1.json | 2 +- .../documents/admob.v1beta.json | 2 +- .../discovery_cache/documents/adsense.v2.json | 2 +- .../documents/alertcenter.v1beta1.json | 2 +- .../documents/analyticsadmin.v1alpha.json | 2 +- .../documents/analyticsdata.v1beta.json | 2 +- .../documents/analyticshub.v1beta1.json | 2 +- .../androiddeviceprovisioning.v1.json | 2 +- .../documents/androidenterprise.v1.json | 2 +- .../documents/androidmanagement.v1.json | 30 +- .../documents/androidpublisher.v3.json | 2 +- .../documents/apigateway.v1.json | 2 +- .../documents/apigateway.v1beta.json | 2 +- .../discovery_cache/documents/apikeys.v2.json | 2 +- .../documents/appengine.v1.json | 2 +- .../documents/appengine.v1alpha.json | 2 +- .../documents/appengine.v1beta.json | 2 +- .../documents/area120tables.v1alpha1.json | 2 +- .../documents/artifactregistry.v1.json | 2 +- .../documents/artifactregistry.v1beta1.json | 2 +- .../documents/artifactregistry.v1beta2.json | 2 +- .../authorizedbuyersmarketplace.v1.json | 2 +- .../documents/bigquery.v2.json | 2 +- .../documents/bigqueryconnection.v1beta1.json | 2 +- .../documents/bigquerydatatransfer.v1.json | 4 +- .../documents/bigqueryreservation.v1.json | 2 +- .../bigqueryreservation.v1beta1.json | 2 +- .../discovery_cache/documents/blogger.v2.json | 2 +- .../discovery_cache/documents/blogger.v3.json | 2 +- .../businessprofileperformance.v1.json | 2 +- .../documents/calendar.v3.json | 2 +- .../discovery_cache/documents/chat.v1.json | 4 +- .../documents/chromeuxreport.v1.json | 2 +- .../documents/classroom.v1.json | 2 +- .../documents/cloudasset.v1.json | 2 +- .../documents/cloudasset.v1beta1.json | 2 +- .../documents/cloudasset.v1p1beta1.json | 2 +- .../documents/cloudasset.v1p5beta1.json | 2 +- .../documents/cloudasset.v1p7beta1.json | 2 +- .../documents/cloudbilling.v1.json | 2 +- .../documents/cloudchannel.v1.json | 2 +- .../documents/clouddebugger.v2.json | 2 +- .../clouderrorreporting.v1beta1.json | 2 +- .../documents/cloudidentity.v1.json | 2 +- .../documents/cloudidentity.v1beta1.json | 2 +- .../documents/cloudprofiler.v2.json | 2 +- .../documents/cloudresourcemanager.v1.json | 4 +- .../cloudresourcemanager.v1beta1.json | 4 +- .../documents/cloudresourcemanager.v2.json | 2 +- .../cloudresourcemanager.v2beta1.json | 2 +- .../documents/cloudresourcemanager.v3.json | 4 +- .../documents/cloudshell.v1.json | 2 +- .../documents/cloudsupport.v2beta.json | 2 +- .../documents/cloudtrace.v1.json | 2 +- .../documents/cloudtrace.v2.json | 2 +- .../documents/cloudtrace.v2beta1.json | 2 +- .../documents/composer.v1.json | 2 +- .../documents/composer.v1beta1.json | 2 +- .../documents/contactcenterinsights.v1.json | 2 +- .../documents/container.v1.json | 2 +- .../documents/container.v1beta1.json | 2 +- .../documents/customsearch.v1.json | 2 +- .../documents/dataflow.v1b3.json | 2 +- .../documents/datamigration.v1.json | 2 +- .../documents/datamigration.v1beta1.json | 2 +- .../documents/datapipelines.v1.json | 2 +- .../documents/deploymentmanager.alpha.json | 20 +- .../documents/deploymentmanager.v2.json | 20 +- .../documents/deploymentmanager.v2beta.json | 20 +- .../documents/digitalassetlinks.v1.json | 2 +- .../documents/displayvideo.v1.json | 2 +- .../discovery_cache/documents/dlp.v2.json | 6 +- .../discovery_cache/documents/dns.v1.json | 2 +- .../documents/dns.v1beta2.json | 2 +- .../discovery_cache/documents/docs.v1.json | 2 +- .../discovery_cache/documents/domains.v1.json | 4 +- .../documents/domains.v1alpha2.json | 4 +- .../documents/domains.v1beta1.json | 4 +- .../documents/domainsrdap.v1.json | 2 +- .../documents/doubleclickbidmanager.v1.1.json | 2 +- .../documents/doubleclickbidmanager.v2.json | 156 +++--- .../documents/doubleclicksearch.v2.json | 2 +- .../documents/driveactivity.v2.json | 2 +- .../documents/essentialcontacts.v1.json | 2 +- .../documents/eventarc.v1.json | 2 +- .../documents/eventarc.v1beta1.json | 2 +- .../documents/factchecktools.v1alpha1.json | 2 +- .../discovery_cache/documents/fcm.v1.json | 2 +- .../documents/fcmdata.v1beta1.json | 2 +- .../documents/firebase.v1beta1.json | 2 +- .../documents/firebaseappcheck.v1.json | 2 +- .../documents/firebaseappcheck.v1beta.json | 2 +- .../documents/firebasedatabase.v1beta.json | 2 +- .../documents/firebasedynamiclinks.v1.json | 2 +- .../documents/firebaseml.v1.json | 2 +- .../documents/firebaseml.v1beta2.json | 2 +- .../documents/firebasestorage.v1beta.json | 2 +- .../discovery_cache/documents/fitness.v1.json | 2 +- .../discovery_cache/documents/forms.v1.json | 2 +- .../discovery_cache/documents/games.v1.json | 2 +- .../gamesConfiguration.v1configuration.json | 2 +- .../gamesManagement.v1management.json | 2 +- .../documents/gameservices.v1.json | 2 +- .../documents/gameservices.v1beta.json | 2 +- .../documents/genomics.v2alpha1.json | 2 +- .../discovery_cache/documents/gmail.v1.json | 2 +- .../documents/gmailpostmastertools.v1.json | 2 +- .../gmailpostmastertools.v1beta1.json | 2 +- .../documents/healthcare.v1.json | 2 +- .../documents/healthcare.v1beta1.json | 2 +- .../documents/homegraph.v1.json | 2 +- .../discovery_cache/documents/iam.v1.json | 2 +- .../discovery_cache/documents/iam.v2beta.json | 2 +- .../documents/iamcredentials.v1.json | 2 +- .../documents/ideahub.v1alpha.json | 2 +- .../documents/ideahub.v1beta.json | 2 +- .../documents/indexing.v3.json | 2 +- .../discovery_cache/documents/keep.v1.json | 2 +- .../documents/kgsearch.v1.json | 2 +- .../documents/language.v1.json | 2 +- .../documents/language.v1beta1.json | 2 +- .../documents/language.v1beta2.json | 2 +- .../documents/libraryagent.v1.json | 2 +- .../documents/licensing.v1.json | 2 +- .../documents/localservices.v1.json | 2 +- .../discovery_cache/documents/logging.v2.json | 8 +- .../documents/manufacturers.v1.json | 2 +- .../documents/memcache.v1.json | 6 +- .../documents/memcache.v1beta2.json | 6 +- .../documents/metastore.v1alpha.json | 2 +- .../documents/metastore.v1beta.json | 2 +- .../discovery_cache/documents/ml.v1.json | 2 +- .../documents/monitoring.v1.json | 2 +- .../documents/monitoring.v3.json | 2 +- .../documents/mybusinessbusinesscalls.v1.json | 2 +- .../mybusinessbusinessinformation.v1.json | 2 +- .../documents/mybusinesslodging.v1.json | 2 +- .../documents/mybusinessnotifications.v1.json | 2 +- .../documents/mybusinessplaceactions.v1.json | 2 +- .../documents/mybusinessqanda.v1.json | 2 +- .../documents/mybusinessverifications.v1.json | 2 +- .../documents/networkmanagement.v1.json | 2 +- .../documents/networkmanagement.v1beta1.json | 2 +- .../documents/networksecurity.v1.json | 10 +- .../documents/networksecurity.v1beta1.json | 10 +- .../documents/networkservices.v1.json | 2 +- .../documents/networkservices.v1beta1.json | 2 +- .../documents/orgpolicy.v2.json | 2 +- .../discovery_cache/documents/oslogin.v1.json | 2 +- .../documents/oslogin.v1alpha.json | 2 +- .../documents/oslogin.v1beta.json | 2 +- .../documents/pagespeedonline.v5.json | 2 +- .../paymentsresellersubscription.v1.json | 2 +- .../discovery_cache/documents/people.v1.json | 2 +- .../documents/playcustomapp.v1.json | 2 +- .../playdeveloperreporting.v1alpha1.json | 2 +- .../playdeveloperreporting.v1beta1.json | 2 +- .../documents/playintegrity.v1.json | 2 +- .../documents/policyanalyzer.v1.json | 2 +- .../documents/policyanalyzer.v1beta1.json | 2 +- .../documents/policytroubleshooter.v1.json | 2 +- .../policytroubleshooter.v1beta.json | 2 +- .../documents/prod_tt_sasportal.v1alpha1.json | 2 +- .../discovery_cache/documents/pubsub.v1.json | 2 +- .../documents/pubsub.v1beta1a.json | 2 +- .../documents/pubsub.v1beta2.json | 2 +- .../documents/pubsublite.v1.json | 2 +- .../documents/realtimebidding.v1.json | 2 +- .../documents/realtimebidding.v1alpha.json | 2 +- .../documents/recaptchaenterprise.v1.json | 2 +- .../recommendationengine.v1beta1.json | 2 +- .../documents/recommender.v1.json | 2 +- .../documents/recommender.v1beta1.json | 2 +- .../discovery_cache/documents/redis.v1.json | 2 +- .../documents/redis.v1beta1.json | 2 +- .../documents/reseller.v1.json | 2 +- .../documents/resourcesettings.v1.json | 2 +- .../documents/runtimeconfig.v1.json | 2 +- .../documents/safebrowsing.v4.json | 2 +- .../documents/sasportal.v1alpha1.json | 2 +- .../discovery_cache/documents/script.v1.json | 2 +- .../documents/searchconsole.v1.json | 2 +- .../documents/secretmanager.v1.json | 2 +- .../documents/secretmanager.v1beta1.json | 2 +- .../serviceconsumermanagement.v1.json | 2 +- .../serviceconsumermanagement.v1beta1.json | 2 +- .../documents/servicecontrol.v1.json | 2 +- .../documents/servicecontrol.v2.json | 2 +- .../documents/servicedirectory.v1.json | 2 +- .../documents/servicedirectory.v1beta1.json | 2 +- .../documents/servicemanagement.v1.json | 2 +- .../documents/serviceusage.v1.json | 2 +- .../documents/serviceusage.v1beta1.json | 2 +- .../documents/smartdevicemanagement.v1.json | 2 +- .../documents/sourcerepo.v1.json | 2 +- .../discovery_cache/documents/speech.v1.json | 2 +- .../documents/speech.v1p1beta1.json | 2 +- .../documents/speech.v2beta1.json | 2 +- .../discovery_cache/documents/storage.v1.json | 4 +- .../documents/streetviewpublish.v1.json | 2 +- .../discovery_cache/documents/sts.v1.json | 2 +- .../discovery_cache/documents/sts.v1beta.json | 2 +- .../documents/tagmanager.v1.json | 2 +- .../documents/tagmanager.v2.json | 2 +- .../discovery_cache/documents/tasks.v1.json | 2 +- .../discovery_cache/documents/testing.v1.json | 2 +- .../documents/texttospeech.v1.json | 2 +- .../documents/texttospeech.v1beta1.json | 2 +- .../documents/toolresults.v1beta3.json | 2 +- .../discovery_cache/documents/tpu.v1.json | 8 +- .../documents/tpu.v1alpha1.json | 8 +- .../documents/tpu.v2alpha1.json | 8 +- .../documents/trafficdirector.v2.json | 2 +- .../documents/transcoder.v1.json | 2 +- .../documents/translate.v3.json | 2 +- .../documents/translate.v3beta1.json | 2 +- .../discovery_cache/documents/vault.v1.json | 2 +- .../documents/versionhistory.v1.json | 2 +- .../discovery_cache/documents/vision.v1.json | 2 +- .../documents/vision.v1p1beta1.json | 2 +- .../documents/vision.v1p2beta1.json | 2 +- .../documents/vmmigration.v1.json | 2 +- .../documents/vmmigration.v1alpha1.json | 2 +- .../discovery_cache/documents/webrisk.v1.json | 26 +- .../documents/websecurityscanner.v1.json | 2 +- .../documents/websecurityscanner.v1alpha.json | 2 +- .../documents/websecurityscanner.v1beta.json | 2 +- .../documents/workflowexecutions.v1.json | 2 +- .../documents/workflowexecutions.v1beta.json | 2 +- .../documents/workflows.v1.json | 2 +- .../documents/workflows.v1beta.json | 2 +- .../documents/youtubeAnalytics.v2.json | 2 +- .../documents/youtubereporting.v1.json | 2 +- 292 files changed, 1337 insertions(+), 1265 deletions(-) diff --git a/docs/dyn/androidmanagement_v1.enterprises.enrollmentTokens.html b/docs/dyn/androidmanagement_v1.enterprises.enrollmentTokens.html index 239868845d5..3e5bad94817 100644 --- a/docs/dyn/androidmanagement_v1.enterprises.enrollmentTokens.html +++ b/docs/dyn/androidmanagement_v1.enterprises.enrollmentTokens.html @@ -110,7 +110,7 @@

Method Details

{ # An enrollment token. "additionalData": "A String", # Optional, arbitrary data associated with the enrollment token. This could contain, for example, the ID of an org unit the device is assigned to after enrollment. After a device enrolls with the token, this data will be exposed in the enrollment_token_data field of the Device resource. The data must be 1024 characters or less; otherwise, the creation request will fail. "allowPersonalUsage": "A String", # Controls whether personal usage is allowed on a device provisioned with this enrollment token.For company-owned devices: Enabling personal usage allows the user to set up a work profile on the device. Disabling personal usage requires the user provision the device as a fully managed device.For personally-owned devices: Enabling personal usage allows the user to set up a work profile on the device. Disabling personal usage will prevent the device from provisioning. Personal usage cannot be disabled on personally-owned device. - "duration": "A String", # The length of time the enrollment token is valid, ranging from 1 minute to 90 days. If not specified, the default duration is 1 hour. + "duration": "A String", # The length of time the enrollment token is valid, ranging from 1 minute to Durations.MAX_VALUE (https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/util/Durations.html#MAX_VALUE), approximately 10,000 years. If not specified, the default duration is 1 hour. Please note that if requested duration causes the resulting expiration_timestamp to exceed Timestamps.MAX_VALUE (https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/util/Timestamps.html#MAX_VALUE), then expiration_timestamp is coerced to Timestamps.MAX_VALUE. "expirationTimestamp": "A String", # The expiration time of the token. This is a read-only field generated by the server. "name": "A String", # The name of the enrollment token, which is generated by the server during creation, in the form enterprises/{enterpriseId}/enrollmentTokens/{enrollmentTokenId}. "oneTimeOnly": True or False, # Whether the enrollment token is for one time use only. If the flag is set to true, only one device can use it for registration. @@ -133,7 +133,7 @@

Method Details

{ # An enrollment token. "additionalData": "A String", # Optional, arbitrary data associated with the enrollment token. This could contain, for example, the ID of an org unit the device is assigned to after enrollment. After a device enrolls with the token, this data will be exposed in the enrollment_token_data field of the Device resource. The data must be 1024 characters or less; otherwise, the creation request will fail. "allowPersonalUsage": "A String", # Controls whether personal usage is allowed on a device provisioned with this enrollment token.For company-owned devices: Enabling personal usage allows the user to set up a work profile on the device. Disabling personal usage requires the user provision the device as a fully managed device.For personally-owned devices: Enabling personal usage allows the user to set up a work profile on the device. Disabling personal usage will prevent the device from provisioning. Personal usage cannot be disabled on personally-owned device. - "duration": "A String", # The length of time the enrollment token is valid, ranging from 1 minute to 90 days. If not specified, the default duration is 1 hour. + "duration": "A String", # The length of time the enrollment token is valid, ranging from 1 minute to Durations.MAX_VALUE (https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/util/Durations.html#MAX_VALUE), approximately 10,000 years. If not specified, the default duration is 1 hour. Please note that if requested duration causes the resulting expiration_timestamp to exceed Timestamps.MAX_VALUE (https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/util/Timestamps.html#MAX_VALUE), then expiration_timestamp is coerced to Timestamps.MAX_VALUE. "expirationTimestamp": "A String", # The expiration time of the token. This is a read-only field generated by the server. "name": "A String", # The name of the enrollment token, which is generated by the server during creation, in the form enterprises/{enterpriseId}/enrollmentTokens/{enrollmentTokenId}. "oneTimeOnly": True or False, # Whether the enrollment token is for one time use only. If the flag is set to true, only one device can use it for registration. @@ -181,7 +181,7 @@

Method Details

{ # An enrollment token. "additionalData": "A String", # Optional, arbitrary data associated with the enrollment token. This could contain, for example, the ID of an org unit the device is assigned to after enrollment. After a device enrolls with the token, this data will be exposed in the enrollment_token_data field of the Device resource. The data must be 1024 characters or less; otherwise, the creation request will fail. "allowPersonalUsage": "A String", # Controls whether personal usage is allowed on a device provisioned with this enrollment token.For company-owned devices: Enabling personal usage allows the user to set up a work profile on the device. Disabling personal usage requires the user provision the device as a fully managed device.For personally-owned devices: Enabling personal usage allows the user to set up a work profile on the device. Disabling personal usage will prevent the device from provisioning. Personal usage cannot be disabled on personally-owned device. - "duration": "A String", # The length of time the enrollment token is valid, ranging from 1 minute to 90 days. If not specified, the default duration is 1 hour. + "duration": "A String", # The length of time the enrollment token is valid, ranging from 1 minute to Durations.MAX_VALUE (https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/util/Durations.html#MAX_VALUE), approximately 10,000 years. If not specified, the default duration is 1 hour. Please note that if requested duration causes the resulting expiration_timestamp to exceed Timestamps.MAX_VALUE (https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/util/Timestamps.html#MAX_VALUE), then expiration_timestamp is coerced to Timestamps.MAX_VALUE. "expirationTimestamp": "A String", # The expiration time of the token. This is a read-only field generated by the server. "name": "A String", # The name of the enrollment token, which is generated by the server during creation, in the form enterprises/{enterpriseId}/enrollmentTokens/{enrollmentTokenId}. "oneTimeOnly": True or False, # Whether the enrollment token is for one time use only. If the flag is set to true, only one device can use it for registration. @@ -215,7 +215,7 @@

Method Details

{ # An enrollment token. "additionalData": "A String", # Optional, arbitrary data associated with the enrollment token. This could contain, for example, the ID of an org unit the device is assigned to after enrollment. After a device enrolls with the token, this data will be exposed in the enrollment_token_data field of the Device resource. The data must be 1024 characters or less; otherwise, the creation request will fail. "allowPersonalUsage": "A String", # Controls whether personal usage is allowed on a device provisioned with this enrollment token.For company-owned devices: Enabling personal usage allows the user to set up a work profile on the device. Disabling personal usage requires the user provision the device as a fully managed device.For personally-owned devices: Enabling personal usage allows the user to set up a work profile on the device. Disabling personal usage will prevent the device from provisioning. Personal usage cannot be disabled on personally-owned device. - "duration": "A String", # The length of time the enrollment token is valid, ranging from 1 minute to 90 days. If not specified, the default duration is 1 hour. + "duration": "A String", # The length of time the enrollment token is valid, ranging from 1 minute to Durations.MAX_VALUE (https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/util/Durations.html#MAX_VALUE), approximately 10,000 years. If not specified, the default duration is 1 hour. Please note that if requested duration causes the resulting expiration_timestamp to exceed Timestamps.MAX_VALUE (https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/util/Timestamps.html#MAX_VALUE), then expiration_timestamp is coerced to Timestamps.MAX_VALUE. "expirationTimestamp": "A String", # The expiration time of the token. This is a read-only field generated by the server. "name": "A String", # The name of the enrollment token, which is generated by the server during creation, in the form enterprises/{enterpriseId}/enrollmentTokens/{enrollmentTokenId}. "oneTimeOnly": True or False, # Whether the enrollment token is for one time use only. If the flag is set to true, only one device can use it for registration. diff --git a/docs/dyn/apigee_v1.organizations.apiproducts.html b/docs/dyn/apigee_v1.organizations.apiproducts.html index a441d1abde1..bbfd152befc 100644 --- a/docs/dyn/apigee_v1.organizations.apiproducts.html +++ b/docs/dyn/apigee_v1.organizations.apiproducts.html @@ -118,7 +118,7 @@

Method Details

The object takes the form of: { - "apiResources": [ # Comma-separated list of API resources to be bundled in the API product. By default, the resource paths are mapped from the `proxy.pathsuffix` variable. The proxy path suffix is defined as the URI fragment following the ProxyEndpoint base path. For example, if the `apiResources` element is defined to be `/forecastrss` and the base path defined for the API proxy is `/weather`, then only requests to `/weather/forecastrss` are permitted by the API product. You can select a specific path, or you can select all subpaths with the following wildcard: - `/**`: Indicates that all sub-URIs are included. - `/*` : Indicates that only URIs one level down are included. By default, / supports the same resources as /** as well as the base path defined by the API proxy. For example, if the base path of the API proxy is `/v1/weatherapikey`, then the API product supports requests to `/v1/weatherapikey` and to any sub-URIs, such as `/v1/weatherapikey/forecastrss`, `/v1/weatherapikey/region/CA`, and so on. For more information, see Managing API products. + "apiResources": [ "A String", ], "approvalType": "A String", # Flag that specifies how API keys are approved to access the APIs defined by the API product. If set to `manual`, the consumer key is generated and returned in "pending" state. In this case, the API keys won't work until they have been explicitly approved. If set to `auto`, the consumer key is generated and returned in "approved" state and can be used immediately. **Note:** Typically, `auto` is used to provide access to free or trial API products that provide limited quota or capabilities. @@ -129,7 +129,7 @@

Method Details

}, ], "createdAt": "A String", # Response only. Creation time of this environment as milliseconds since epoch. - "description": "A String", # Description of the API product. Include key information about the API product that is not captured by other fields. + "description": "A String", # Description of the API product. Include key information about the API product that is not captured by other fields. Comma-separated list of API resources to be bundled in the API product. By default, the resource paths are mapped from the `proxy.pathsuffix` variable. The proxy path suffix is defined as the URI fragment following the ProxyEndpoint base path. For example, if the `apiResources` element is defined to be `/forecastrss` and the base path defined for the API proxy is `/weather`, then only requests to `/weather/forecastrss` are permitted by the API product. You can select a specific path, or you can select all subpaths with the following wildcard: - `/**`: Indicates that all sub-URIs are included. - `/*` : Indicates that only URIs one level down are included. By default, / supports the same resources as /** as well as the base path defined by the API proxy. For example, if the base path of the API proxy is `/v1/weatherapikey`, then the API product supports requests to `/v1/weatherapikey` and to any sub-URIs, such as `/v1/weatherapikey/forecastrss`, `/v1/weatherapikey/region/CA`, and so on. For more information, see Managing API products. "displayName": "A String", # Name displayed in the UI or developer portal to developers registering for API access. "environments": [ # Comma-separated list of environment names to which the API product is bound. Requests to environments that are not listed are rejected. By specifying one or more environments, you can bind the resources listed in the API product to a specific environment, preventing developers from accessing those resources through API proxies deployed in another environment. This setting is used, for example, to prevent resources associated with API proxies in `prod` from being accessed by API proxies deployed in `test`. "A String", @@ -210,7 +210,7 @@

Method Details

An object of the form: { - "apiResources": [ # Comma-separated list of API resources to be bundled in the API product. By default, the resource paths are mapped from the `proxy.pathsuffix` variable. The proxy path suffix is defined as the URI fragment following the ProxyEndpoint base path. For example, if the `apiResources` element is defined to be `/forecastrss` and the base path defined for the API proxy is `/weather`, then only requests to `/weather/forecastrss` are permitted by the API product. You can select a specific path, or you can select all subpaths with the following wildcard: - `/**`: Indicates that all sub-URIs are included. - `/*` : Indicates that only URIs one level down are included. By default, / supports the same resources as /** as well as the base path defined by the API proxy. For example, if the base path of the API proxy is `/v1/weatherapikey`, then the API product supports requests to `/v1/weatherapikey` and to any sub-URIs, such as `/v1/weatherapikey/forecastrss`, `/v1/weatherapikey/region/CA`, and so on. For more information, see Managing API products. + "apiResources": [ "A String", ], "approvalType": "A String", # Flag that specifies how API keys are approved to access the APIs defined by the API product. If set to `manual`, the consumer key is generated and returned in "pending" state. In this case, the API keys won't work until they have been explicitly approved. If set to `auto`, the consumer key is generated and returned in "approved" state and can be used immediately. **Note:** Typically, `auto` is used to provide access to free or trial API products that provide limited quota or capabilities. @@ -221,7 +221,7 @@

Method Details

}, ], "createdAt": "A String", # Response only. Creation time of this environment as milliseconds since epoch. - "description": "A String", # Description of the API product. Include key information about the API product that is not captured by other fields. + "description": "A String", # Description of the API product. Include key information about the API product that is not captured by other fields. Comma-separated list of API resources to be bundled in the API product. By default, the resource paths are mapped from the `proxy.pathsuffix` variable. The proxy path suffix is defined as the URI fragment following the ProxyEndpoint base path. For example, if the `apiResources` element is defined to be `/forecastrss` and the base path defined for the API proxy is `/weather`, then only requests to `/weather/forecastrss` are permitted by the API product. You can select a specific path, or you can select all subpaths with the following wildcard: - `/**`: Indicates that all sub-URIs are included. - `/*` : Indicates that only URIs one level down are included. By default, / supports the same resources as /** as well as the base path defined by the API proxy. For example, if the base path of the API proxy is `/v1/weatherapikey`, then the API product supports requests to `/v1/weatherapikey` and to any sub-URIs, such as `/v1/weatherapikey/forecastrss`, `/v1/weatherapikey/region/CA`, and so on. For more information, see Managing API products. "displayName": "A String", # Name displayed in the UI or developer portal to developers registering for API access. "environments": [ # Comma-separated list of environment names to which the API product is bound. Requests to environments that are not listed are rejected. By specifying one or more environments, you can bind the resources listed in the API product to a specific environment, preventing developers from accessing those resources through API proxies deployed in another environment. This setting is used, for example, to prevent resources associated with API proxies in `prod` from being accessed by API proxies deployed in `test`. "A String", @@ -309,7 +309,7 @@

Method Details

An object of the form: { - "apiResources": [ # Comma-separated list of API resources to be bundled in the API product. By default, the resource paths are mapped from the `proxy.pathsuffix` variable. The proxy path suffix is defined as the URI fragment following the ProxyEndpoint base path. For example, if the `apiResources` element is defined to be `/forecastrss` and the base path defined for the API proxy is `/weather`, then only requests to `/weather/forecastrss` are permitted by the API product. You can select a specific path, or you can select all subpaths with the following wildcard: - `/**`: Indicates that all sub-URIs are included. - `/*` : Indicates that only URIs one level down are included. By default, / supports the same resources as /** as well as the base path defined by the API proxy. For example, if the base path of the API proxy is `/v1/weatherapikey`, then the API product supports requests to `/v1/weatherapikey` and to any sub-URIs, such as `/v1/weatherapikey/forecastrss`, `/v1/weatherapikey/region/CA`, and so on. For more information, see Managing API products. + "apiResources": [ "A String", ], "approvalType": "A String", # Flag that specifies how API keys are approved to access the APIs defined by the API product. If set to `manual`, the consumer key is generated and returned in "pending" state. In this case, the API keys won't work until they have been explicitly approved. If set to `auto`, the consumer key is generated and returned in "approved" state and can be used immediately. **Note:** Typically, `auto` is used to provide access to free or trial API products that provide limited quota or capabilities. @@ -320,7 +320,7 @@

Method Details

}, ], "createdAt": "A String", # Response only. Creation time of this environment as milliseconds since epoch. - "description": "A String", # Description of the API product. Include key information about the API product that is not captured by other fields. + "description": "A String", # Description of the API product. Include key information about the API product that is not captured by other fields. Comma-separated list of API resources to be bundled in the API product. By default, the resource paths are mapped from the `proxy.pathsuffix` variable. The proxy path suffix is defined as the URI fragment following the ProxyEndpoint base path. For example, if the `apiResources` element is defined to be `/forecastrss` and the base path defined for the API proxy is `/weather`, then only requests to `/weather/forecastrss` are permitted by the API product. You can select a specific path, or you can select all subpaths with the following wildcard: - `/**`: Indicates that all sub-URIs are included. - `/*` : Indicates that only URIs one level down are included. By default, / supports the same resources as /** as well as the base path defined by the API proxy. For example, if the base path of the API proxy is `/v1/weatherapikey`, then the API product supports requests to `/v1/weatherapikey` and to any sub-URIs, such as `/v1/weatherapikey/forecastrss`, `/v1/weatherapikey/region/CA`, and so on. For more information, see Managing API products. "displayName": "A String", # Name displayed in the UI or developer portal to developers registering for API access. "environments": [ # Comma-separated list of environment names to which the API product is bound. Requests to environments that are not listed are rejected. By specifying one or more environments, you can bind the resources listed in the API product to a specific environment, preventing developers from accessing those resources through API proxies deployed in another environment. This setting is used, for example, to prevent resources associated with API proxies in `prod` from being accessed by API proxies deployed in `test`. "A String", @@ -408,7 +408,7 @@

Method Details

An object of the form: { - "apiResources": [ # Comma-separated list of API resources to be bundled in the API product. By default, the resource paths are mapped from the `proxy.pathsuffix` variable. The proxy path suffix is defined as the URI fragment following the ProxyEndpoint base path. For example, if the `apiResources` element is defined to be `/forecastrss` and the base path defined for the API proxy is `/weather`, then only requests to `/weather/forecastrss` are permitted by the API product. You can select a specific path, or you can select all subpaths with the following wildcard: - `/**`: Indicates that all sub-URIs are included. - `/*` : Indicates that only URIs one level down are included. By default, / supports the same resources as /** as well as the base path defined by the API proxy. For example, if the base path of the API proxy is `/v1/weatherapikey`, then the API product supports requests to `/v1/weatherapikey` and to any sub-URIs, such as `/v1/weatherapikey/forecastrss`, `/v1/weatherapikey/region/CA`, and so on. For more information, see Managing API products. + "apiResources": [ "A String", ], "approvalType": "A String", # Flag that specifies how API keys are approved to access the APIs defined by the API product. If set to `manual`, the consumer key is generated and returned in "pending" state. In this case, the API keys won't work until they have been explicitly approved. If set to `auto`, the consumer key is generated and returned in "approved" state and can be used immediately. **Note:** Typically, `auto` is used to provide access to free or trial API products that provide limited quota or capabilities. @@ -419,7 +419,7 @@

Method Details

}, ], "createdAt": "A String", # Response only. Creation time of this environment as milliseconds since epoch. - "description": "A String", # Description of the API product. Include key information about the API product that is not captured by other fields. + "description": "A String", # Description of the API product. Include key information about the API product that is not captured by other fields. Comma-separated list of API resources to be bundled in the API product. By default, the resource paths are mapped from the `proxy.pathsuffix` variable. The proxy path suffix is defined as the URI fragment following the ProxyEndpoint base path. For example, if the `apiResources` element is defined to be `/forecastrss` and the base path defined for the API proxy is `/weather`, then only requests to `/weather/forecastrss` are permitted by the API product. You can select a specific path, or you can select all subpaths with the following wildcard: - `/**`: Indicates that all sub-URIs are included. - `/*` : Indicates that only URIs one level down are included. By default, / supports the same resources as /** as well as the base path defined by the API proxy. For example, if the base path of the API proxy is `/v1/weatherapikey`, then the API product supports requests to `/v1/weatherapikey` and to any sub-URIs, such as `/v1/weatherapikey/forecastrss`, `/v1/weatherapikey/region/CA`, and so on. For more information, see Managing API products. "displayName": "A String", # Name displayed in the UI or developer portal to developers registering for API access. "environments": [ # Comma-separated list of environment names to which the API product is bound. Requests to environments that are not listed are rejected. By specifying one or more environments, you can bind the resources listed in the API product to a specific environment, preventing developers from accessing those resources through API proxies deployed in another environment. This setting is used, for example, to prevent resources associated with API proxies in `prod` from being accessed by API proxies deployed in `test`. "A String", @@ -514,7 +514,7 @@

Method Details

{ "apiProduct": [ # Lists all API product names defined for an organization. { - "apiResources": [ # Comma-separated list of API resources to be bundled in the API product. By default, the resource paths are mapped from the `proxy.pathsuffix` variable. The proxy path suffix is defined as the URI fragment following the ProxyEndpoint base path. For example, if the `apiResources` element is defined to be `/forecastrss` and the base path defined for the API proxy is `/weather`, then only requests to `/weather/forecastrss` are permitted by the API product. You can select a specific path, or you can select all subpaths with the following wildcard: - `/**`: Indicates that all sub-URIs are included. - `/*` : Indicates that only URIs one level down are included. By default, / supports the same resources as /** as well as the base path defined by the API proxy. For example, if the base path of the API proxy is `/v1/weatherapikey`, then the API product supports requests to `/v1/weatherapikey` and to any sub-URIs, such as `/v1/weatherapikey/forecastrss`, `/v1/weatherapikey/region/CA`, and so on. For more information, see Managing API products. + "apiResources": [ "A String", ], "approvalType": "A String", # Flag that specifies how API keys are approved to access the APIs defined by the API product. If set to `manual`, the consumer key is generated and returned in "pending" state. In this case, the API keys won't work until they have been explicitly approved. If set to `auto`, the consumer key is generated and returned in "approved" state and can be used immediately. **Note:** Typically, `auto` is used to provide access to free or trial API products that provide limited quota or capabilities. @@ -525,7 +525,7 @@

Method Details

}, ], "createdAt": "A String", # Response only. Creation time of this environment as milliseconds since epoch. - "description": "A String", # Description of the API product. Include key information about the API product that is not captured by other fields. + "description": "A String", # Description of the API product. Include key information about the API product that is not captured by other fields. Comma-separated list of API resources to be bundled in the API product. By default, the resource paths are mapped from the `proxy.pathsuffix` variable. The proxy path suffix is defined as the URI fragment following the ProxyEndpoint base path. For example, if the `apiResources` element is defined to be `/forecastrss` and the base path defined for the API proxy is `/weather`, then only requests to `/weather/forecastrss` are permitted by the API product. You can select a specific path, or you can select all subpaths with the following wildcard: - `/**`: Indicates that all sub-URIs are included. - `/*` : Indicates that only URIs one level down are included. By default, / supports the same resources as /** as well as the base path defined by the API proxy. For example, if the base path of the API proxy is `/v1/weatherapikey`, then the API product supports requests to `/v1/weatherapikey` and to any sub-URIs, such as `/v1/weatherapikey/forecastrss`, `/v1/weatherapikey/region/CA`, and so on. For more information, see Managing API products. "displayName": "A String", # Name displayed in the UI or developer portal to developers registering for API access. "environments": [ # Comma-separated list of environment names to which the API product is bound. Requests to environments that are not listed are rejected. By specifying one or more environments, you can bind the resources listed in the API product to a specific environment, preventing developers from accessing those resources through API proxies deployed in another environment. This setting is used, for example, to prevent resources associated with API proxies in `prod` from being accessed by API proxies deployed in `test`. "A String", @@ -610,7 +610,7 @@

Method Details

The object takes the form of: { - "apiResources": [ # Comma-separated list of API resources to be bundled in the API product. By default, the resource paths are mapped from the `proxy.pathsuffix` variable. The proxy path suffix is defined as the URI fragment following the ProxyEndpoint base path. For example, if the `apiResources` element is defined to be `/forecastrss` and the base path defined for the API proxy is `/weather`, then only requests to `/weather/forecastrss` are permitted by the API product. You can select a specific path, or you can select all subpaths with the following wildcard: - `/**`: Indicates that all sub-URIs are included. - `/*` : Indicates that only URIs one level down are included. By default, / supports the same resources as /** as well as the base path defined by the API proxy. For example, if the base path of the API proxy is `/v1/weatherapikey`, then the API product supports requests to `/v1/weatherapikey` and to any sub-URIs, such as `/v1/weatherapikey/forecastrss`, `/v1/weatherapikey/region/CA`, and so on. For more information, see Managing API products. + "apiResources": [ "A String", ], "approvalType": "A String", # Flag that specifies how API keys are approved to access the APIs defined by the API product. If set to `manual`, the consumer key is generated and returned in "pending" state. In this case, the API keys won't work until they have been explicitly approved. If set to `auto`, the consumer key is generated and returned in "approved" state and can be used immediately. **Note:** Typically, `auto` is used to provide access to free or trial API products that provide limited quota or capabilities. @@ -621,7 +621,7 @@

Method Details

}, ], "createdAt": "A String", # Response only. Creation time of this environment as milliseconds since epoch. - "description": "A String", # Description of the API product. Include key information about the API product that is not captured by other fields. + "description": "A String", # Description of the API product. Include key information about the API product that is not captured by other fields. Comma-separated list of API resources to be bundled in the API product. By default, the resource paths are mapped from the `proxy.pathsuffix` variable. The proxy path suffix is defined as the URI fragment following the ProxyEndpoint base path. For example, if the `apiResources` element is defined to be `/forecastrss` and the base path defined for the API proxy is `/weather`, then only requests to `/weather/forecastrss` are permitted by the API product. You can select a specific path, or you can select all subpaths with the following wildcard: - `/**`: Indicates that all sub-URIs are included. - `/*` : Indicates that only URIs one level down are included. By default, / supports the same resources as /** as well as the base path defined by the API proxy. For example, if the base path of the API proxy is `/v1/weatherapikey`, then the API product supports requests to `/v1/weatherapikey` and to any sub-URIs, such as `/v1/weatherapikey/forecastrss`, `/v1/weatherapikey/region/CA`, and so on. For more information, see Managing API products. "displayName": "A String", # Name displayed in the UI or developer portal to developers registering for API access. "environments": [ # Comma-separated list of environment names to which the API product is bound. Requests to environments that are not listed are rejected. By specifying one or more environments, you can bind the resources listed in the API product to a specific environment, preventing developers from accessing those resources through API proxies deployed in another environment. This setting is used, for example, to prevent resources associated with API proxies in `prod` from being accessed by API proxies deployed in `test`. "A String", @@ -702,7 +702,7 @@

Method Details

An object of the form: { - "apiResources": [ # Comma-separated list of API resources to be bundled in the API product. By default, the resource paths are mapped from the `proxy.pathsuffix` variable. The proxy path suffix is defined as the URI fragment following the ProxyEndpoint base path. For example, if the `apiResources` element is defined to be `/forecastrss` and the base path defined for the API proxy is `/weather`, then only requests to `/weather/forecastrss` are permitted by the API product. You can select a specific path, or you can select all subpaths with the following wildcard: - `/**`: Indicates that all sub-URIs are included. - `/*` : Indicates that only URIs one level down are included. By default, / supports the same resources as /** as well as the base path defined by the API proxy. For example, if the base path of the API proxy is `/v1/weatherapikey`, then the API product supports requests to `/v1/weatherapikey` and to any sub-URIs, such as `/v1/weatherapikey/forecastrss`, `/v1/weatherapikey/region/CA`, and so on. For more information, see Managing API products. + "apiResources": [ "A String", ], "approvalType": "A String", # Flag that specifies how API keys are approved to access the APIs defined by the API product. If set to `manual`, the consumer key is generated and returned in "pending" state. In this case, the API keys won't work until they have been explicitly approved. If set to `auto`, the consumer key is generated and returned in "approved" state and can be used immediately. **Note:** Typically, `auto` is used to provide access to free or trial API products that provide limited quota or capabilities. @@ -713,7 +713,7 @@

Method Details

}, ], "createdAt": "A String", # Response only. Creation time of this environment as milliseconds since epoch. - "description": "A String", # Description of the API product. Include key information about the API product that is not captured by other fields. + "description": "A String", # Description of the API product. Include key information about the API product that is not captured by other fields. Comma-separated list of API resources to be bundled in the API product. By default, the resource paths are mapped from the `proxy.pathsuffix` variable. The proxy path suffix is defined as the URI fragment following the ProxyEndpoint base path. For example, if the `apiResources` element is defined to be `/forecastrss` and the base path defined for the API proxy is `/weather`, then only requests to `/weather/forecastrss` are permitted by the API product. You can select a specific path, or you can select all subpaths with the following wildcard: - `/**`: Indicates that all sub-URIs are included. - `/*` : Indicates that only URIs one level down are included. By default, / supports the same resources as /** as well as the base path defined by the API proxy. For example, if the base path of the API proxy is `/v1/weatherapikey`, then the API product supports requests to `/v1/weatherapikey` and to any sub-URIs, such as `/v1/weatherapikey/forecastrss`, `/v1/weatherapikey/region/CA`, and so on. For more information, see Managing API products. "displayName": "A String", # Name displayed in the UI or developer portal to developers registering for API access. "environments": [ # Comma-separated list of environment names to which the API product is bound. Requests to environments that are not listed are rejected. By specifying one or more environments, you can bind the resources listed in the API product to a specific environment, preventing developers from accessing those resources through API proxies deployed in another environment. This setting is used, for example, to prevent resources associated with API proxies in `prod` from being accessed by API proxies deployed in `test`. "A String", diff --git a/docs/dyn/apigee_v1.organizations.environments.html b/docs/dyn/apigee_v1.organizations.environments.html index e884a473026..f741dff034e 100644 --- a/docs/dyn/apigee_v1.organizations.environments.html +++ b/docs/dyn/apigee_v1.organizations.environments.html @@ -167,7 +167,7 @@

Instance Methods

Creates an environment in an organization.

delete(name, x__xgafv=None)

-

Deletes an environment from an organization. **Warning: You must delete all key value maps and key value entries before you delete an environment.** Otherwise, if you re-create the environment the key value map entry operations will encounter encryption/decryption discrepancies.

+

Deletes an environment from an organization. **Note**: You must delete all key value maps and key value entries before you can delete an environment.

get(name, x__xgafv=None)

Gets environment details.

@@ -274,7 +274,7 @@

Method Details

delete(name, x__xgafv=None) -
Deletes an environment from an organization. **Warning: You must delete all key value maps and key value entries before you delete an environment.** Otherwise, if you re-create the environment the key value map entry operations will encounter encryption/decryption discrepancies.
+  
Deletes an environment from an organization. **Note**: You must delete all key value maps and key value entries before you can delete an environment.
 
 Args:
   name: string, Required. Name of the environment. Use the following structure in your request: `organizations/{org}/environments/{env}` (required)
diff --git a/docs/dyn/bigquerydatatransfer_v1.projects.locations.transferConfigs.html b/docs/dyn/bigquerydatatransfer_v1.projects.locations.transferConfigs.html
index 0ac21fd10f1..507601a765b 100644
--- a/docs/dyn/bigquerydatatransfer_v1.projects.locations.transferConfigs.html
+++ b/docs/dyn/bigquerydatatransfer_v1.projects.locations.transferConfigs.html
@@ -123,7 +123,7 @@ 

Method Details

{ # Represents a data transfer configuration. A transfer configuration contains all metadata needed to perform a data transfer. For example, `destination_dataset_id` specifies where data should be stored. When a new transfer configuration is created, the specified `destination_dataset_id` is created when needed and shared with the appropriate data source service account. "dataRefreshWindowDays": 42, # The number of days to look back to automatically refresh the data. For example, if `data_refresh_window_days = 10`, then every day BigQuery reingests data for [today-10, today-1], rather than ingesting data for just [today-1]. Only valid if the data source supports the feature. Set the value to 0 to use the default value. - "dataSourceId": "A String", # Data source id. Cannot be changed once data transfer is created. + "dataSourceId": "A String", # Data source id. Cannot be changed once data transfer is created. The full list of available data source ids can be returned through API call: https://cloud.google.com/bigquery-transfer/docs/reference/datatransfer/rest/v1/projects.locations.dataSources/list The individual data source id can also be found in the bq tab in the 'Setting up a data transfer' section for each data source. For example, the data source id for Cloud Storage transfers is listed here: https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq "datasetRegion": "A String", # Output only. Region in which BigQuery dataset is located. "destinationDatasetId": "A String", # The BigQuery target dataset id. "disabled": True or False, # Is this config disabled. When set to true, no runs are scheduled for a given transfer. @@ -164,7 +164,7 @@

Method Details

{ # Represents a data transfer configuration. A transfer configuration contains all metadata needed to perform a data transfer. For example, `destination_dataset_id` specifies where data should be stored. When a new transfer configuration is created, the specified `destination_dataset_id` is created when needed and shared with the appropriate data source service account. "dataRefreshWindowDays": 42, # The number of days to look back to automatically refresh the data. For example, if `data_refresh_window_days = 10`, then every day BigQuery reingests data for [today-10, today-1], rather than ingesting data for just [today-1]. Only valid if the data source supports the feature. Set the value to 0 to use the default value. - "dataSourceId": "A String", # Data source id. Cannot be changed once data transfer is created. + "dataSourceId": "A String", # Data source id. Cannot be changed once data transfer is created. The full list of available data source ids can be returned through API call: https://cloud.google.com/bigquery-transfer/docs/reference/datatransfer/rest/v1/projects.locations.dataSources/list The individual data source id can also be found in the bq tab in the 'Setting up a data transfer' section for each data source. For example, the data source id for Cloud Storage transfers is listed here: https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq "datasetRegion": "A String", # Output only. Region in which BigQuery dataset is located. "destinationDatasetId": "A String", # The BigQuery target dataset id. "disabled": True or False, # Is this config disabled. When set to true, no runs are scheduled for a given transfer. @@ -227,7 +227,7 @@

Method Details

{ # Represents a data transfer configuration. A transfer configuration contains all metadata needed to perform a data transfer. For example, `destination_dataset_id` specifies where data should be stored. When a new transfer configuration is created, the specified `destination_dataset_id` is created when needed and shared with the appropriate data source service account. "dataRefreshWindowDays": 42, # The number of days to look back to automatically refresh the data. For example, if `data_refresh_window_days = 10`, then every day BigQuery reingests data for [today-10, today-1], rather than ingesting data for just [today-1]. Only valid if the data source supports the feature. Set the value to 0 to use the default value. - "dataSourceId": "A String", # Data source id. Cannot be changed once data transfer is created. + "dataSourceId": "A String", # Data source id. Cannot be changed once data transfer is created. The full list of available data source ids can be returned through API call: https://cloud.google.com/bigquery-transfer/docs/reference/datatransfer/rest/v1/projects.locations.dataSources/list The individual data source id can also be found in the bq tab in the 'Setting up a data transfer' section for each data source. For example, the data source id for Cloud Storage transfers is listed here: https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq "datasetRegion": "A String", # Output only. Region in which BigQuery dataset is located. "destinationDatasetId": "A String", # The BigQuery target dataset id. "disabled": True or False, # Is this config disabled. When set to true, no runs are scheduled for a given transfer. @@ -278,7 +278,7 @@

Method Details

"transferConfigs": [ # Output only. The stored pipeline transfer configurations. { # Represents a data transfer configuration. A transfer configuration contains all metadata needed to perform a data transfer. For example, `destination_dataset_id` specifies where data should be stored. When a new transfer configuration is created, the specified `destination_dataset_id` is created when needed and shared with the appropriate data source service account. "dataRefreshWindowDays": 42, # The number of days to look back to automatically refresh the data. For example, if `data_refresh_window_days = 10`, then every day BigQuery reingests data for [today-10, today-1], rather than ingesting data for just [today-1]. Only valid if the data source supports the feature. Set the value to 0 to use the default value. - "dataSourceId": "A String", # Data source id. Cannot be changed once data transfer is created. + "dataSourceId": "A String", # Data source id. Cannot be changed once data transfer is created. The full list of available data source ids can be returned through API call: https://cloud.google.com/bigquery-transfer/docs/reference/datatransfer/rest/v1/projects.locations.dataSources/list The individual data source id can also be found in the bq tab in the 'Setting up a data transfer' section for each data source. For example, the data source id for Cloud Storage transfers is listed here: https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq "datasetRegion": "A String", # Output only. Region in which BigQuery dataset is located. "destinationDatasetId": "A String", # The BigQuery target dataset id. "disabled": True or False, # Is this config disabled. When set to true, no runs are scheduled for a given transfer. @@ -334,7 +334,7 @@

Method Details

{ # Represents a data transfer configuration. A transfer configuration contains all metadata needed to perform a data transfer. For example, `destination_dataset_id` specifies where data should be stored. When a new transfer configuration is created, the specified `destination_dataset_id` is created when needed and shared with the appropriate data source service account. "dataRefreshWindowDays": 42, # The number of days to look back to automatically refresh the data. For example, if `data_refresh_window_days = 10`, then every day BigQuery reingests data for [today-10, today-1], rather than ingesting data for just [today-1]. Only valid if the data source supports the feature. Set the value to 0 to use the default value. - "dataSourceId": "A String", # Data source id. Cannot be changed once data transfer is created. + "dataSourceId": "A String", # Data source id. Cannot be changed once data transfer is created. The full list of available data source ids can be returned through API call: https://cloud.google.com/bigquery-transfer/docs/reference/datatransfer/rest/v1/projects.locations.dataSources/list The individual data source id can also be found in the bq tab in the 'Setting up a data transfer' section for each data source. For example, the data source id for Cloud Storage transfers is listed here: https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq "datasetRegion": "A String", # Output only. Region in which BigQuery dataset is located. "destinationDatasetId": "A String", # The BigQuery target dataset id. "disabled": True or False, # Is this config disabled. When set to true, no runs are scheduled for a given transfer. @@ -376,7 +376,7 @@

Method Details

{ # Represents a data transfer configuration. A transfer configuration contains all metadata needed to perform a data transfer. For example, `destination_dataset_id` specifies where data should be stored. When a new transfer configuration is created, the specified `destination_dataset_id` is created when needed and shared with the appropriate data source service account. "dataRefreshWindowDays": 42, # The number of days to look back to automatically refresh the data. For example, if `data_refresh_window_days = 10`, then every day BigQuery reingests data for [today-10, today-1], rather than ingesting data for just [today-1]. Only valid if the data source supports the feature. Set the value to 0 to use the default value. - "dataSourceId": "A String", # Data source id. Cannot be changed once data transfer is created. + "dataSourceId": "A String", # Data source id. Cannot be changed once data transfer is created. The full list of available data source ids can be returned through API call: https://cloud.google.com/bigquery-transfer/docs/reference/datatransfer/rest/v1/projects.locations.dataSources/list The individual data source id can also be found in the bq tab in the 'Setting up a data transfer' section for each data source. For example, the data source id for Cloud Storage transfers is listed here: https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq "datasetRegion": "A String", # Output only. Region in which BigQuery dataset is located. "destinationDatasetId": "A String", # The BigQuery target dataset id. "disabled": True or False, # Is this config disabled. When set to true, no runs are scheduled for a given transfer. diff --git a/docs/dyn/bigquerydatatransfer_v1.projects.transferConfigs.html b/docs/dyn/bigquerydatatransfer_v1.projects.transferConfigs.html index 82087c55c27..398b426f65c 100644 --- a/docs/dyn/bigquerydatatransfer_v1.projects.transferConfigs.html +++ b/docs/dyn/bigquerydatatransfer_v1.projects.transferConfigs.html @@ -123,7 +123,7 @@

Method Details

{ # Represents a data transfer configuration. A transfer configuration contains all metadata needed to perform a data transfer. For example, `destination_dataset_id` specifies where data should be stored. When a new transfer configuration is created, the specified `destination_dataset_id` is created when needed and shared with the appropriate data source service account. "dataRefreshWindowDays": 42, # The number of days to look back to automatically refresh the data. For example, if `data_refresh_window_days = 10`, then every day BigQuery reingests data for [today-10, today-1], rather than ingesting data for just [today-1]. Only valid if the data source supports the feature. Set the value to 0 to use the default value. - "dataSourceId": "A String", # Data source id. Cannot be changed once data transfer is created. + "dataSourceId": "A String", # Data source id. Cannot be changed once data transfer is created. The full list of available data source ids can be returned through API call: https://cloud.google.com/bigquery-transfer/docs/reference/datatransfer/rest/v1/projects.locations.dataSources/list The individual data source id can also be found in the bq tab in the 'Setting up a data transfer' section for each data source. For example, the data source id for Cloud Storage transfers is listed here: https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq "datasetRegion": "A String", # Output only. Region in which BigQuery dataset is located. "destinationDatasetId": "A String", # The BigQuery target dataset id. "disabled": True or False, # Is this config disabled. When set to true, no runs are scheduled for a given transfer. @@ -164,7 +164,7 @@

Method Details

{ # Represents a data transfer configuration. A transfer configuration contains all metadata needed to perform a data transfer. For example, `destination_dataset_id` specifies where data should be stored. When a new transfer configuration is created, the specified `destination_dataset_id` is created when needed and shared with the appropriate data source service account. "dataRefreshWindowDays": 42, # The number of days to look back to automatically refresh the data. For example, if `data_refresh_window_days = 10`, then every day BigQuery reingests data for [today-10, today-1], rather than ingesting data for just [today-1]. Only valid if the data source supports the feature. Set the value to 0 to use the default value. - "dataSourceId": "A String", # Data source id. Cannot be changed once data transfer is created. + "dataSourceId": "A String", # Data source id. Cannot be changed once data transfer is created. The full list of available data source ids can be returned through API call: https://cloud.google.com/bigquery-transfer/docs/reference/datatransfer/rest/v1/projects.locations.dataSources/list The individual data source id can also be found in the bq tab in the 'Setting up a data transfer' section for each data source. For example, the data source id for Cloud Storage transfers is listed here: https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq "datasetRegion": "A String", # Output only. Region in which BigQuery dataset is located. "destinationDatasetId": "A String", # The BigQuery target dataset id. "disabled": True or False, # Is this config disabled. When set to true, no runs are scheduled for a given transfer. @@ -227,7 +227,7 @@

Method Details

{ # Represents a data transfer configuration. A transfer configuration contains all metadata needed to perform a data transfer. For example, `destination_dataset_id` specifies where data should be stored. When a new transfer configuration is created, the specified `destination_dataset_id` is created when needed and shared with the appropriate data source service account. "dataRefreshWindowDays": 42, # The number of days to look back to automatically refresh the data. For example, if `data_refresh_window_days = 10`, then every day BigQuery reingests data for [today-10, today-1], rather than ingesting data for just [today-1]. Only valid if the data source supports the feature. Set the value to 0 to use the default value. - "dataSourceId": "A String", # Data source id. Cannot be changed once data transfer is created. + "dataSourceId": "A String", # Data source id. Cannot be changed once data transfer is created. The full list of available data source ids can be returned through API call: https://cloud.google.com/bigquery-transfer/docs/reference/datatransfer/rest/v1/projects.locations.dataSources/list The individual data source id can also be found in the bq tab in the 'Setting up a data transfer' section for each data source. For example, the data source id for Cloud Storage transfers is listed here: https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq "datasetRegion": "A String", # Output only. Region in which BigQuery dataset is located. "destinationDatasetId": "A String", # The BigQuery target dataset id. "disabled": True or False, # Is this config disabled. When set to true, no runs are scheduled for a given transfer. @@ -278,7 +278,7 @@

Method Details

"transferConfigs": [ # Output only. The stored pipeline transfer configurations. { # Represents a data transfer configuration. A transfer configuration contains all metadata needed to perform a data transfer. For example, `destination_dataset_id` specifies where data should be stored. When a new transfer configuration is created, the specified `destination_dataset_id` is created when needed and shared with the appropriate data source service account. "dataRefreshWindowDays": 42, # The number of days to look back to automatically refresh the data. For example, if `data_refresh_window_days = 10`, then every day BigQuery reingests data for [today-10, today-1], rather than ingesting data for just [today-1]. Only valid if the data source supports the feature. Set the value to 0 to use the default value. - "dataSourceId": "A String", # Data source id. Cannot be changed once data transfer is created. + "dataSourceId": "A String", # Data source id. Cannot be changed once data transfer is created. The full list of available data source ids can be returned through API call: https://cloud.google.com/bigquery-transfer/docs/reference/datatransfer/rest/v1/projects.locations.dataSources/list The individual data source id can also be found in the bq tab in the 'Setting up a data transfer' section for each data source. For example, the data source id for Cloud Storage transfers is listed here: https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq "datasetRegion": "A String", # Output only. Region in which BigQuery dataset is located. "destinationDatasetId": "A String", # The BigQuery target dataset id. "disabled": True or False, # Is this config disabled. When set to true, no runs are scheduled for a given transfer. @@ -334,7 +334,7 @@

Method Details

{ # Represents a data transfer configuration. A transfer configuration contains all metadata needed to perform a data transfer. For example, `destination_dataset_id` specifies where data should be stored. When a new transfer configuration is created, the specified `destination_dataset_id` is created when needed and shared with the appropriate data source service account. "dataRefreshWindowDays": 42, # The number of days to look back to automatically refresh the data. For example, if `data_refresh_window_days = 10`, then every day BigQuery reingests data for [today-10, today-1], rather than ingesting data for just [today-1]. Only valid if the data source supports the feature. Set the value to 0 to use the default value. - "dataSourceId": "A String", # Data source id. Cannot be changed once data transfer is created. + "dataSourceId": "A String", # Data source id. Cannot be changed once data transfer is created. The full list of available data source ids can be returned through API call: https://cloud.google.com/bigquery-transfer/docs/reference/datatransfer/rest/v1/projects.locations.dataSources/list The individual data source id can also be found in the bq tab in the 'Setting up a data transfer' section for each data source. For example, the data source id for Cloud Storage transfers is listed here: https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq "datasetRegion": "A String", # Output only. Region in which BigQuery dataset is located. "destinationDatasetId": "A String", # The BigQuery target dataset id. "disabled": True or False, # Is this config disabled. When set to true, no runs are scheduled for a given transfer. @@ -376,7 +376,7 @@

Method Details

{ # Represents a data transfer configuration. A transfer configuration contains all metadata needed to perform a data transfer. For example, `destination_dataset_id` specifies where data should be stored. When a new transfer configuration is created, the specified `destination_dataset_id` is created when needed and shared with the appropriate data source service account. "dataRefreshWindowDays": 42, # The number of days to look back to automatically refresh the data. For example, if `data_refresh_window_days = 10`, then every day BigQuery reingests data for [today-10, today-1], rather than ingesting data for just [today-1]. Only valid if the data source supports the feature. Set the value to 0 to use the default value. - "dataSourceId": "A String", # Data source id. Cannot be changed once data transfer is created. + "dataSourceId": "A String", # Data source id. Cannot be changed once data transfer is created. The full list of available data source ids can be returned through API call: https://cloud.google.com/bigquery-transfer/docs/reference/datatransfer/rest/v1/projects.locations.dataSources/list The individual data source id can also be found in the bq tab in the 'Setting up a data transfer' section for each data source. For example, the data source id for Cloud Storage transfers is listed here: https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq "datasetRegion": "A String", # Output only. Region in which BigQuery dataset is located. "destinationDatasetId": "A String", # The BigQuery target dataset id. "disabled": True or False, # Is this config disabled. When set to true, no runs are scheduled for a given transfer. diff --git a/docs/dyn/chat_v1.dms.conversations.html b/docs/dyn/chat_v1.dms.conversations.html index aeff145d8e7..6018a65c1d1 100644 --- a/docs/dyn/chat_v1.dms.conversations.html +++ b/docs/dyn/chat_v1.dms.conversations.html @@ -938,7 +938,7 @@

Method Details

], "createTime": "A String", # Output only. The time at which the message was created in Google Chat server. "fallbackText": "A String", # A plain-text description of the message's cards, used when the actual cards cannot be displayed (e.g. mobile notifications). - "lastUpdateTime": "A String", # Output only. The time at which the message was last updated. If the message was never updated, this field matches `create_time`. + "lastUpdateTime": "A String", # Output only. The time at which the message was last edited by a user. If the message has never been edited, this field is empty. "matchedUrl": { # A matched url in a Chat message. Chat apps can preview matched URLs. For more information, refer to [Preview links](https://developers.google.com/chat/how-tos/preview-links). # Output only. A URL in `spaces.messages.text` that matches a link preview pattern. For more information, refer to [Preview links](https://developers.google.com/chat/how-tos/preview-links). "url": "A String", # Output only. The url that was matched. }, @@ -1819,7 +1819,7 @@

Method Details

], "createTime": "A String", # Output only. The time at which the message was created in Google Chat server. "fallbackText": "A String", # A plain-text description of the message's cards, used when the actual cards cannot be displayed (e.g. mobile notifications). - "lastUpdateTime": "A String", # Output only. The time at which the message was last updated. If the message was never updated, this field matches `create_time`. + "lastUpdateTime": "A String", # Output only. The time at which the message was last edited by a user. If the message has never been edited, this field is empty. "matchedUrl": { # A matched url in a Chat message. Chat apps can preview matched URLs. For more information, refer to [Preview links](https://developers.google.com/chat/how-tos/preview-links). # Output only. A URL in `spaces.messages.text` that matches a link preview pattern. For more information, refer to [Preview links](https://developers.google.com/chat/how-tos/preview-links). "url": "A String", # Output only. The url that was matched. }, diff --git a/docs/dyn/chat_v1.dms.html b/docs/dyn/chat_v1.dms.html index ed6c3d9b2ec..9889d77d1a3 100644 --- a/docs/dyn/chat_v1.dms.html +++ b/docs/dyn/chat_v1.dms.html @@ -946,7 +946,7 @@

Method Details

], "createTime": "A String", # Output only. The time at which the message was created in Google Chat server. "fallbackText": "A String", # A plain-text description of the message's cards, used when the actual cards cannot be displayed (e.g. mobile notifications). - "lastUpdateTime": "A String", # Output only. The time at which the message was last updated. If the message was never updated, this field matches `create_time`. + "lastUpdateTime": "A String", # Output only. The time at which the message was last edited by a user. If the message has never been edited, this field is empty. "matchedUrl": { # A matched url in a Chat message. Chat apps can preview matched URLs. For more information, refer to [Preview links](https://developers.google.com/chat/how-tos/preview-links). # Output only. A URL in `spaces.messages.text` that matches a link preview pattern. For more information, refer to [Preview links](https://developers.google.com/chat/how-tos/preview-links). "url": "A String", # Output only. The url that was matched. }, @@ -1827,7 +1827,7 @@

Method Details

], "createTime": "A String", # Output only. The time at which the message was created in Google Chat server. "fallbackText": "A String", # A plain-text description of the message's cards, used when the actual cards cannot be displayed (e.g. mobile notifications). - "lastUpdateTime": "A String", # Output only. The time at which the message was last updated. If the message was never updated, this field matches `create_time`. + "lastUpdateTime": "A String", # Output only. The time at which the message was last edited by a user. If the message has never been edited, this field is empty. "matchedUrl": { # A matched url in a Chat message. Chat apps can preview matched URLs. For more information, refer to [Preview links](https://developers.google.com/chat/how-tos/preview-links). # Output only. A URL in `spaces.messages.text` that matches a link preview pattern. For more information, refer to [Preview links](https://developers.google.com/chat/how-tos/preview-links). "url": "A String", # Output only. The url that was matched. }, @@ -2708,7 +2708,7 @@

Method Details

], "createTime": "A String", # Output only. The time at which the message was created in Google Chat server. "fallbackText": "A String", # A plain-text description of the message's cards, used when the actual cards cannot be displayed (e.g. mobile notifications). - "lastUpdateTime": "A String", # Output only. The time at which the message was last updated. If the message was never updated, this field matches `create_time`. + "lastUpdateTime": "A String", # Output only. The time at which the message was last edited by a user. If the message has never been edited, this field is empty. "matchedUrl": { # A matched url in a Chat message. Chat apps can preview matched URLs. For more information, refer to [Preview links](https://developers.google.com/chat/how-tos/preview-links). # Output only. A URL in `spaces.messages.text` that matches a link preview pattern. For more information, refer to [Preview links](https://developers.google.com/chat/how-tos/preview-links). "url": "A String", # Output only. The url that was matched. }, @@ -3589,7 +3589,7 @@

Method Details

], "createTime": "A String", # Output only. The time at which the message was created in Google Chat server. "fallbackText": "A String", # A plain-text description of the message's cards, used when the actual cards cannot be displayed (e.g. mobile notifications). - "lastUpdateTime": "A String", # Output only. The time at which the message was last updated. If the message was never updated, this field matches `create_time`. + "lastUpdateTime": "A String", # Output only. The time at which the message was last edited by a user. If the message has never been edited, this field is empty. "matchedUrl": { # A matched url in a Chat message. Chat apps can preview matched URLs. For more information, refer to [Preview links](https://developers.google.com/chat/how-tos/preview-links). # Output only. A URL in `spaces.messages.text` that matches a link preview pattern. For more information, refer to [Preview links](https://developers.google.com/chat/how-tos/preview-links). "url": "A String", # Output only. The url that was matched. }, diff --git a/docs/dyn/chat_v1.rooms.conversations.html b/docs/dyn/chat_v1.rooms.conversations.html index 434b2410a2c..84549e3916a 100644 --- a/docs/dyn/chat_v1.rooms.conversations.html +++ b/docs/dyn/chat_v1.rooms.conversations.html @@ -938,7 +938,7 @@

Method Details

], "createTime": "A String", # Output only. The time at which the message was created in Google Chat server. "fallbackText": "A String", # A plain-text description of the message's cards, used when the actual cards cannot be displayed (e.g. mobile notifications). - "lastUpdateTime": "A String", # Output only. The time at which the message was last updated. If the message was never updated, this field matches `create_time`. + "lastUpdateTime": "A String", # Output only. The time at which the message was last edited by a user. If the message has never been edited, this field is empty. "matchedUrl": { # A matched url in a Chat message. Chat apps can preview matched URLs. For more information, refer to [Preview links](https://developers.google.com/chat/how-tos/preview-links). # Output only. A URL in `spaces.messages.text` that matches a link preview pattern. For more information, refer to [Preview links](https://developers.google.com/chat/how-tos/preview-links). "url": "A String", # Output only. The url that was matched. }, @@ -1819,7 +1819,7 @@

Method Details

], "createTime": "A String", # Output only. The time at which the message was created in Google Chat server. "fallbackText": "A String", # A plain-text description of the message's cards, used when the actual cards cannot be displayed (e.g. mobile notifications). - "lastUpdateTime": "A String", # Output only. The time at which the message was last updated. If the message was never updated, this field matches `create_time`. + "lastUpdateTime": "A String", # Output only. The time at which the message was last edited by a user. If the message has never been edited, this field is empty. "matchedUrl": { # A matched url in a Chat message. Chat apps can preview matched URLs. For more information, refer to [Preview links](https://developers.google.com/chat/how-tos/preview-links). # Output only. A URL in `spaces.messages.text` that matches a link preview pattern. For more information, refer to [Preview links](https://developers.google.com/chat/how-tos/preview-links). "url": "A String", # Output only. The url that was matched. }, diff --git a/docs/dyn/chat_v1.rooms.html b/docs/dyn/chat_v1.rooms.html index 4c6a5e8b259..65f5cdd41d7 100644 --- a/docs/dyn/chat_v1.rooms.html +++ b/docs/dyn/chat_v1.rooms.html @@ -946,7 +946,7 @@

Method Details

], "createTime": "A String", # Output only. The time at which the message was created in Google Chat server. "fallbackText": "A String", # A plain-text description of the message's cards, used when the actual cards cannot be displayed (e.g. mobile notifications). - "lastUpdateTime": "A String", # Output only. The time at which the message was last updated. If the message was never updated, this field matches `create_time`. + "lastUpdateTime": "A String", # Output only. The time at which the message was last edited by a user. If the message has never been edited, this field is empty. "matchedUrl": { # A matched url in a Chat message. Chat apps can preview matched URLs. For more information, refer to [Preview links](https://developers.google.com/chat/how-tos/preview-links). # Output only. A URL in `spaces.messages.text` that matches a link preview pattern. For more information, refer to [Preview links](https://developers.google.com/chat/how-tos/preview-links). "url": "A String", # Output only. The url that was matched. }, @@ -1827,7 +1827,7 @@

Method Details

], "createTime": "A String", # Output only. The time at which the message was created in Google Chat server. "fallbackText": "A String", # A plain-text description of the message's cards, used when the actual cards cannot be displayed (e.g. mobile notifications). - "lastUpdateTime": "A String", # Output only. The time at which the message was last updated. If the message was never updated, this field matches `create_time`. + "lastUpdateTime": "A String", # Output only. The time at which the message was last edited by a user. If the message has never been edited, this field is empty. "matchedUrl": { # A matched url in a Chat message. Chat apps can preview matched URLs. For more information, refer to [Preview links](https://developers.google.com/chat/how-tos/preview-links). # Output only. A URL in `spaces.messages.text` that matches a link preview pattern. For more information, refer to [Preview links](https://developers.google.com/chat/how-tos/preview-links). "url": "A String", # Output only. The url that was matched. }, @@ -2708,7 +2708,7 @@

Method Details

], "createTime": "A String", # Output only. The time at which the message was created in Google Chat server. "fallbackText": "A String", # A plain-text description of the message's cards, used when the actual cards cannot be displayed (e.g. mobile notifications). - "lastUpdateTime": "A String", # Output only. The time at which the message was last updated. If the message was never updated, this field matches `create_time`. + "lastUpdateTime": "A String", # Output only. The time at which the message was last edited by a user. If the message has never been edited, this field is empty. "matchedUrl": { # A matched url in a Chat message. Chat apps can preview matched URLs. For more information, refer to [Preview links](https://developers.google.com/chat/how-tos/preview-links). # Output only. A URL in `spaces.messages.text` that matches a link preview pattern. For more information, refer to [Preview links](https://developers.google.com/chat/how-tos/preview-links). "url": "A String", # Output only. The url that was matched. }, @@ -3589,7 +3589,7 @@

Method Details

], "createTime": "A String", # Output only. The time at which the message was created in Google Chat server. "fallbackText": "A String", # A plain-text description of the message's cards, used when the actual cards cannot be displayed (e.g. mobile notifications). - "lastUpdateTime": "A String", # Output only. The time at which the message was last updated. If the message was never updated, this field matches `create_time`. + "lastUpdateTime": "A String", # Output only. The time at which the message was last edited by a user. If the message has never been edited, this field is empty. "matchedUrl": { # A matched url in a Chat message. Chat apps can preview matched URLs. For more information, refer to [Preview links](https://developers.google.com/chat/how-tos/preview-links). # Output only. A URL in `spaces.messages.text` that matches a link preview pattern. For more information, refer to [Preview links](https://developers.google.com/chat/how-tos/preview-links). "url": "A String", # Output only. The url that was matched. }, diff --git a/docs/dyn/chat_v1.spaces.html b/docs/dyn/chat_v1.spaces.html index 70313d1513b..3ca47c9a15a 100644 --- a/docs/dyn/chat_v1.spaces.html +++ b/docs/dyn/chat_v1.spaces.html @@ -1023,7 +1023,7 @@

Method Details

], "createTime": "A String", # Output only. The time at which the message was created in Google Chat server. "fallbackText": "A String", # A plain-text description of the message's cards, used when the actual cards cannot be displayed (e.g. mobile notifications). - "lastUpdateTime": "A String", # Output only. The time at which the message was last updated. If the message was never updated, this field matches `create_time`. + "lastUpdateTime": "A String", # Output only. The time at which the message was last edited by a user. If the message has never been edited, this field is empty. "matchedUrl": { # A matched url in a Chat message. Chat apps can preview matched URLs. For more information, refer to [Preview links](https://developers.google.com/chat/how-tos/preview-links). # Output only. A URL in `spaces.messages.text` that matches a link preview pattern. For more information, refer to [Preview links](https://developers.google.com/chat/how-tos/preview-links). "url": "A String", # Output only. The url that was matched. }, @@ -1904,7 +1904,7 @@

Method Details

], "createTime": "A String", # Output only. The time at which the message was created in Google Chat server. "fallbackText": "A String", # A plain-text description of the message's cards, used when the actual cards cannot be displayed (e.g. mobile notifications). - "lastUpdateTime": "A String", # Output only. The time at which the message was last updated. If the message was never updated, this field matches `create_time`. + "lastUpdateTime": "A String", # Output only. The time at which the message was last edited by a user. If the message has never been edited, this field is empty. "matchedUrl": { # A matched url in a Chat message. Chat apps can preview matched URLs. For more information, refer to [Preview links](https://developers.google.com/chat/how-tos/preview-links). # Output only. A URL in `spaces.messages.text` that matches a link preview pattern. For more information, refer to [Preview links](https://developers.google.com/chat/how-tos/preview-links). "url": "A String", # Output only. The url that was matched. }, diff --git a/docs/dyn/chat_v1.spaces.messages.html b/docs/dyn/chat_v1.spaces.messages.html index 11eb97e9896..71d10caf399 100644 --- a/docs/dyn/chat_v1.spaces.messages.html +++ b/docs/dyn/chat_v1.spaces.messages.html @@ -952,7 +952,7 @@

Method Details

], "createTime": "A String", # Output only. The time at which the message was created in Google Chat server. "fallbackText": "A String", # A plain-text description of the message's cards, used when the actual cards cannot be displayed (e.g. mobile notifications). - "lastUpdateTime": "A String", # Output only. The time at which the message was last updated. If the message was never updated, this field matches `create_time`. + "lastUpdateTime": "A String", # Output only. The time at which the message was last edited by a user. If the message has never been edited, this field is empty. "matchedUrl": { # A matched url in a Chat message. Chat apps can preview matched URLs. For more information, refer to [Preview links](https://developers.google.com/chat/how-tos/preview-links). # Output only. A URL in `spaces.messages.text` that matches a link preview pattern. For more information, refer to [Preview links](https://developers.google.com/chat/how-tos/preview-links). "url": "A String", # Output only. The url that was matched. }, @@ -1833,7 +1833,7 @@

Method Details

], "createTime": "A String", # Output only. The time at which the message was created in Google Chat server. "fallbackText": "A String", # A plain-text description of the message's cards, used when the actual cards cannot be displayed (e.g. mobile notifications). - "lastUpdateTime": "A String", # Output only. The time at which the message was last updated. If the message was never updated, this field matches `create_time`. + "lastUpdateTime": "A String", # Output only. The time at which the message was last edited by a user. If the message has never been edited, this field is empty. "matchedUrl": { # A matched url in a Chat message. Chat apps can preview matched URLs. For more information, refer to [Preview links](https://developers.google.com/chat/how-tos/preview-links). # Output only. A URL in `spaces.messages.text` that matches a link preview pattern. For more information, refer to [Preview links](https://developers.google.com/chat/how-tos/preview-links). "url": "A String", # Output only. The url that was matched. }, @@ -2737,7 +2737,7 @@

Method Details

], "createTime": "A String", # Output only. The time at which the message was created in Google Chat server. "fallbackText": "A String", # A plain-text description of the message's cards, used when the actual cards cannot be displayed (e.g. mobile notifications). - "lastUpdateTime": "A String", # Output only. The time at which the message was last updated. If the message was never updated, this field matches `create_time`. + "lastUpdateTime": "A String", # Output only. The time at which the message was last edited by a user. If the message has never been edited, this field is empty. "matchedUrl": { # A matched url in a Chat message. Chat apps can preview matched URLs. For more information, refer to [Preview links](https://developers.google.com/chat/how-tos/preview-links). # Output only. A URL in `spaces.messages.text` that matches a link preview pattern. For more information, refer to [Preview links](https://developers.google.com/chat/how-tos/preview-links). "url": "A String", # Output only. The url that was matched. }, @@ -3618,7 +3618,7 @@

Method Details

], "createTime": "A String", # Output only. The time at which the message was created in Google Chat server. "fallbackText": "A String", # A plain-text description of the message's cards, used when the actual cards cannot be displayed (e.g. mobile notifications). - "lastUpdateTime": "A String", # Output only. The time at which the message was last updated. If the message was never updated, this field matches `create_time`. + "lastUpdateTime": "A String", # Output only. The time at which the message was last edited by a user. If the message has never been edited, this field is empty. "matchedUrl": { # A matched url in a Chat message. Chat apps can preview matched URLs. For more information, refer to [Preview links](https://developers.google.com/chat/how-tos/preview-links). # Output only. A URL in `spaces.messages.text` that matches a link preview pattern. For more information, refer to [Preview links](https://developers.google.com/chat/how-tos/preview-links). "url": "A String", # Output only. The url that was matched. }, @@ -4498,7 +4498,7 @@

Method Details

], "createTime": "A String", # Output only. The time at which the message was created in Google Chat server. "fallbackText": "A String", # A plain-text description of the message's cards, used when the actual cards cannot be displayed (e.g. mobile notifications). - "lastUpdateTime": "A String", # Output only. The time at which the message was last updated. If the message was never updated, this field matches `create_time`. + "lastUpdateTime": "A String", # Output only. The time at which the message was last edited by a user. If the message has never been edited, this field is empty. "matchedUrl": { # A matched url in a Chat message. Chat apps can preview matched URLs. For more information, refer to [Preview links](https://developers.google.com/chat/how-tos/preview-links). # Output only. A URL in `spaces.messages.text` that matches a link preview pattern. For more information, refer to [Preview links](https://developers.google.com/chat/how-tos/preview-links). "url": "A String", # Output only. The url that was matched. }, diff --git a/docs/dyn/cloudresourcemanager_v1.projects.html b/docs/dyn/cloudresourcemanager_v1.projects.html index 66adf5f4237..236b3a54ae2 100644 --- a/docs/dyn/cloudresourcemanager_v1.projects.html +++ b/docs/dyn/cloudresourcemanager_v1.projects.html @@ -449,7 +449,7 @@

Method Details

Lists Projects that the caller has the `resourcemanager.projects.get` permission on and satisfy the specified filter. This method returns Projects in an unspecified order. This method is eventually consistent with project mutations; this means that a newly created project may not appear in the results or recent updates to an existing project may not be reflected in the results. To retrieve the latest state of a project, use the GetProject method. NOTE: If the request filter contains a `parent.type` and `parent.id` and the caller has the `resourcemanager.projects.list` permission on the parent, the results will be drawn from an alternate index which provides more consistent results. In future versions of this API, this List method will be split into List and Search to properly capture the behavioral difference.
 
 Args:
-  filter: string, Optional. An expression for filtering the results of the request. Filter rules are case insensitive. If multiple fields are included in a filter query, the query will return results that match any of the fields. Some eligible fields for filtering are: + `name` + `id` + `labels.` (where *key* is the name of a label) + `parent.type` + `parent.id` + `lifecycleState` Some examples of filter queries: | Query | Description | |------------------|-----------------------------------------------------| | name:how* | The project's name starts with "how". | | name:Howl | The project's name is `Howl` or `howl`. | | name:HOWL | Equivalent to above. | | NAME:howl | Equivalent to above. | | labels.color:* | The project has the label `color`. | | labels.color:red | The project's label `color` has the value `red`. | | labels.color:red labels.size:big | The project's label `color` has the value `red` and its label `size` has the value `big`.| | lifecycleState:DELETE_REQUESTED | Only show projects that are pending deletion.| If no filter is specified, the call will return projects for which the user has the `resourcemanager.projects.get` permission. NOTE: To perform a by-parent query (eg., what projects are directly in a Folder), the caller must have the `resourcemanager.projects.list` permission on the parent and the filter must contain both a `parent.type` and a `parent.id` restriction (example: "parent.type:folder parent.id:123"). In this case an alternate search index is used which provides more consistent results.
+  filter: string, Optional. An expression for filtering the results of the request. Filter rules are case insensitive. If multiple fields are included in a filter query, the query will return results that match any of the fields. Some eligible fields for filtering are: + `name` + `id` + `labels.` (where *key* is the name of a label) + `parent.type` + `parent.id` + `lifecycleState` Some examples of filter queries: | Query | Description | |------------------|-----------------------------------------------------| | name:how* | The project's name starts with "how". | | name:Howl | The project's name is `Howl` or `howl`. | | name:HOWL | Equivalent to above. | | NAME:howl | Equivalent to above. | | labels.color:* | The project has the label `color`. | | labels.color:red | The project's label `color` has the value `red`. | | labels.color:red labels.size:big | The project's label `color` has the value `red` or its label `size` has the value `big`. | | lifecycleState:DELETE_REQUESTED | Only show projects that are pending deletion.| If no filter is specified, the call will return projects for which the user has the `resourcemanager.projects.get` permission. NOTE: To perform a by-parent query (eg., what projects are directly in a Folder), the caller must have the `resourcemanager.projects.list` permission on the parent and the filter must contain both a `parent.type` and a `parent.id` restriction (example: "parent.type:folder parent.id:123"). In this case an alternate search index is used which provides more consistent results.
   pageSize: integer, Optional. The maximum number of Projects to return in the response. The server can return fewer Projects than requested. If unspecified, server picks an appropriate default.
   pageToken: string, Optional. A pagination token returned from a previous call to ListProjects that indicates from where listing should continue.
   x__xgafv: string, V1 error format.
diff --git a/docs/dyn/cloudresourcemanager_v1beta1.projects.html b/docs/dyn/cloudresourcemanager_v1beta1.projects.html
index 15e7fb66beb..7418014ae18 100644
--- a/docs/dyn/cloudresourcemanager_v1beta1.projects.html
+++ b/docs/dyn/cloudresourcemanager_v1beta1.projects.html
@@ -305,7 +305,7 @@ 

Method Details

Lists Projects that the caller has the `resourcemanager.projects.get` permission on and satisfy the specified filter. This method returns Projects in an unspecified order. This method is eventually consistent with project mutations; this means that a newly created project may not appear in the results or recent updates to an existing project may not be reflected in the results. To retrieve the latest state of a project, use the GetProject method. NOTE: If the request filter contains a `parent.type` and `parent.id` and the caller has the `resourcemanager.projects.list` permission on the parent, the results will be drawn from an alternate index which provides more consistent results. In future versions of this API, this List method will be split into List and Search to properly capture the behavioral difference.
 
 Args:
-  filter: string, An expression for filtering the results of the request. Filter rules are case insensitive. If multiple fields are included in a filter query, the query will return results that match any of the fields. Some eligible fields for filtering are: + `name` + `id` + `labels.` (where *key* is the name of a label) + `parent.type` + `parent.id` Some examples of using labels as filters: | Filter | Description | |------------------|-----------------------------------------------------| | name:how* | The project's name starts with "how". | | name:Howl | The project's name is `Howl` or `howl`. | | name:HOWL | Equivalent to above. | | NAME:howl | Equivalent to above. | | labels.color:* | The project has the label `color`. | | labels.color:red | The project's label `color` has the value `red`. | | labels.color:red labels.size:big |The project's label `color` has the value `red` and its label `size` has the value `big`. | If no filter is specified, the call will return projects for which the user has the `resourcemanager.projects.get` permission. NOTE: To perform a by-parent query (eg., what projects are directly in a Folder), the caller must have the `resourcemanager.projects.list` permission on the parent and the filter must contain both a `parent.type` and a `parent.id` restriction (example: "parent.type:folder parent.id:123"). In this case an alternate search index is used which provides more consistent results. Optional.
+  filter: string, An expression for filtering the results of the request. Filter rules are case insensitive. If multiple fields are included in a filter query, the query will return results that match any of the fields. Some eligible fields for filtering are: + `name` + `id` + `labels.` (where *key* is the name of a label) + `parent.type` + `parent.id` Some examples of using labels as filters: | Filter | Description | |------------------|-----------------------------------------------------| | name:how* | The project's name starts with "how". | | name:Howl | The project's name is `Howl` or `howl`. | | name:HOWL | Equivalent to above. | | NAME:howl | Equivalent to above. | | labels.color:* | The project has the label `color`. | | labels.color:red | The project's label `color` has the value `red`. | | labels.color:red labels.size:big | The project's label `color` has the value `red` or its label `size` has the value `big`. | If no filter is specified, the call will return projects for which the user has the `resourcemanager.projects.get` permission. NOTE: To perform a by-parent query (eg., what projects are directly in a Folder), the caller must have the `resourcemanager.projects.list` permission on the parent and the filter must contain both a `parent.type` and a `parent.id` restriction (example: "parent.type:folder parent.id:123"). In this case an alternate search index is used which provides more consistent results. Optional.
   pageSize: integer, The maximum number of Projects to return in the response. The server can return fewer Projects than requested. If unspecified, server picks an appropriate default. Optional.
   pageToken: string, A pagination token returned from a previous call to ListProjects that indicates from where listing should continue. Optional.
   x__xgafv: string, V1 error format.
diff --git a/docs/dyn/cloudresourcemanager_v3.projects.html b/docs/dyn/cloudresourcemanager_v3.projects.html
index 953d6f2076d..66dd8f05bd7 100644
--- a/docs/dyn/cloudresourcemanager_v3.projects.html
+++ b/docs/dyn/cloudresourcemanager_v3.projects.html
@@ -450,7 +450,7 @@ 

Method Details

Args: pageSize: integer, Optional. The maximum number of projects to return in the response. The server can return fewer projects than requested. If unspecified, server picks an appropriate default. pageToken: string, Optional. A pagination token returned from a previous call to ListProjects that indicates from where listing should continue. - query: string, Optional. A query string for searching for projects that the caller has `resourcemanager.projects.get` permission to. If multiple fields are included in the query, then it will return results that match any of the fields. Some eligible fields are: ``` | Field | Description | |-------------------------|----------------------------------------------| | displayName, name | Filters by displayName. | | parent | Project's parent (for example: folders/123, organizations/*). Prefer parent field over parent.type and parent.id.| | parent.type | Parent's type: `folder` or `organization`. | | parent.id | Parent's id number (for example: 123) | | id, projectId | Filters by projectId. | | state, lifecycleState | Filters by state. | | labels | Filters by label name or value. | | labels.\ (where *key* is the name of a label) | Filters by label name.| ``` Search expressions are case insensitive. Some examples queries: ``` | Query | Description | |------------------|-----------------------------------------------------| | name:how* | The project's name starts with "how". | | name:Howl | The project's name is `Howl` or `howl`. | | name:HOWL | Equivalent to above. | | NAME:howl | Equivalent to above. | | labels.color:* | The project has the label `color`. | | labels.color:red | The project's label `color` has the value `red`. | | labels.color:red labels.size:big | The project's label `color` has the value `red` and its label `size` has the value `big`.| ``` If no query is specified, the call will return projects for which the user has the `resourcemanager.projects.get` permission. + query: string, Optional. A query string for searching for projects that the caller has `resourcemanager.projects.get` permission to. If multiple fields are included in the query, then it will return results that match any of the fields. Some eligible fields are: ``` | Field | Description | |-------------------------|----------------------------------------------| | displayName, name | Filters by displayName. | | parent | Project's parent (for example: folders/123, organizations/*). Prefer parent field over parent.type and parent.id.| | parent.type | Parent's type: `folder` or `organization`. | | parent.id | Parent's id number (for example: 123) | | id, projectId | Filters by projectId. | | state, lifecycleState | Filters by state. | | labels | Filters by label name or value. | | labels.\ (where *key* is the name of a label) | Filters by label name.| ``` Search expressions are case insensitive. Some examples queries: ``` | Query | Description | |------------------|-----------------------------------------------------| | name:how* | The project's name starts with "how". | | name:Howl | The project's name is `Howl` or `howl`. | | name:HOWL | Equivalent to above. | | NAME:howl | Equivalent to above. | | labels.color:* | The project has the label `color`. | | labels.color:red | The project's label `color` has the value `red`. | | labels.color:red labels.size:big | The project's label `color` has the value `red` or its label `size` has the value `big`. | ``` If no query is specified, the call will return projects for which the user has the `resourcemanager.projects.get` permission. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/dialogflow_v3.projects.locations.agents.html b/docs/dyn/dialogflow_v3.projects.locations.agents.html index 2b681fdad6a..72bf16e78fa 100644 --- a/docs/dyn/dialogflow_v3.projects.locations.agents.html +++ b/docs/dyn/dialogflow_v3.projects.locations.agents.html @@ -163,7 +163,7 @@

Method Details

The object takes the form of: { # Agents are best described as Natural Language Understanding (NLU) modules that transform user requests into actionable data. You can include agents in your app, product, or service to determine user intent and respond to the user in a natural way. After you create an agent, you can add Intents, Entity Types, Flows, Fulfillments, Webhooks, and so on to manage the conversation flows.. - "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this agent. The settings exposed at the lower level overrides the settings exposed at the higher level. + "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this agent. The settings exposed at the lower level overrides the settings exposed at the higher level. "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. @@ -197,7 +197,7 @@

Method Details

An object of the form: { # Agents are best described as Natural Language Understanding (NLU) modules that transform user requests into actionable data. You can include agents in your app, product, or service to determine user intent and respond to the user in a natural way. After you create an agent, you can add Intents, Entity Types, Flows, Fulfillments, Webhooks, and so on to manage the conversation flows.. - "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this agent. The settings exposed at the lower level overrides the settings exposed at the higher level. + "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this agent. The settings exposed at the lower level overrides the settings exposed at the higher level. "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. @@ -300,7 +300,7 @@

Method Details

An object of the form: { # Agents are best described as Natural Language Understanding (NLU) modules that transform user requests into actionable data. You can include agents in your app, product, or service to determine user intent and respond to the user in a natural way. After you create an agent, you can add Intents, Entity Types, Flows, Fulfillments, Webhooks, and so on to manage the conversation flows.. - "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this agent. The settings exposed at the lower level overrides the settings exposed at the higher level. + "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this agent. The settings exposed at the lower level overrides the settings exposed at the higher level. "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. @@ -387,7 +387,7 @@

Method Details

{ # The response message for Agents.ListAgents. "agents": [ # The list of agents. There will be a maximum number of items returned based on the page_size field in the request. { # Agents are best described as Natural Language Understanding (NLU) modules that transform user requests into actionable data. You can include agents in your app, product, or service to determine user intent and respond to the user in a natural way. After you create an agent, you can add Intents, Entity Types, Flows, Fulfillments, Webhooks, and so on to manage the conversation flows.. - "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this agent. The settings exposed at the lower level overrides the settings exposed at the higher level. + "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this agent. The settings exposed at the lower level overrides the settings exposed at the higher level. "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. @@ -440,7 +440,7 @@

Method Details

The object takes the form of: { # Agents are best described as Natural Language Understanding (NLU) modules that transform user requests into actionable data. You can include agents in your app, product, or service to determine user intent and respond to the user in a natural way. After you create an agent, you can add Intents, Entity Types, Flows, Fulfillments, Webhooks, and so on to manage the conversation flows.. - "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this agent. The settings exposed at the lower level overrides the settings exposed at the higher level. + "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this agent. The settings exposed at the lower level overrides the settings exposed at the higher level. "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. @@ -475,7 +475,7 @@

Method Details

An object of the form: { # Agents are best described as Natural Language Understanding (NLU) modules that transform user requests into actionable data. You can include agents in your app, product, or service to determine user intent and respond to the user in a natural way. After you create an agent, you can add Intents, Entity Types, Flows, Fulfillments, Webhooks, and so on to manage the conversation flows.. - "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this agent. The settings exposed at the lower level overrides the settings exposed at the higher level. + "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this agent. The settings exposed at the lower level overrides the settings exposed at the higher level. "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. diff --git a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.html b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.html index e92abde7e23..e8e9d7cbc64 100644 --- a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.html +++ b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.html @@ -163,7 +163,7 @@

Method Details

The object takes the form of: { # Agents are best described as Natural Language Understanding (NLU) modules that transform user requests into actionable data. You can include agents in your app, product, or service to determine user intent and respond to the user in a natural way. After you create an agent, you can add Intents, Entity Types, Flows, Fulfillments, Webhooks, and so on to manage the conversation flows.. - "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this agent. The settings exposed at the lower level overrides the settings exposed at the higher level. + "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this agent. The settings exposed at the lower level overrides the settings exposed at the higher level. "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. @@ -197,7 +197,7 @@

Method Details

An object of the form: { # Agents are best described as Natural Language Understanding (NLU) modules that transform user requests into actionable data. You can include agents in your app, product, or service to determine user intent and respond to the user in a natural way. After you create an agent, you can add Intents, Entity Types, Flows, Fulfillments, Webhooks, and so on to manage the conversation flows.. - "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this agent. The settings exposed at the lower level overrides the settings exposed at the higher level. + "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this agent. The settings exposed at the lower level overrides the settings exposed at the higher level. "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. @@ -300,7 +300,7 @@

Method Details

An object of the form: { # Agents are best described as Natural Language Understanding (NLU) modules that transform user requests into actionable data. You can include agents in your app, product, or service to determine user intent and respond to the user in a natural way. After you create an agent, you can add Intents, Entity Types, Flows, Fulfillments, Webhooks, and so on to manage the conversation flows.. - "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this agent. The settings exposed at the lower level overrides the settings exposed at the higher level. + "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this agent. The settings exposed at the lower level overrides the settings exposed at the higher level. "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. @@ -387,7 +387,7 @@

Method Details

{ # The response message for Agents.ListAgents. "agents": [ # The list of agents. There will be a maximum number of items returned based on the page_size field in the request. { # Agents are best described as Natural Language Understanding (NLU) modules that transform user requests into actionable data. You can include agents in your app, product, or service to determine user intent and respond to the user in a natural way. After you create an agent, you can add Intents, Entity Types, Flows, Fulfillments, Webhooks, and so on to manage the conversation flows.. - "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this agent. The settings exposed at the lower level overrides the settings exposed at the higher level. + "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this agent. The settings exposed at the lower level overrides the settings exposed at the higher level. "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. @@ -440,7 +440,7 @@

Method Details

The object takes the form of: { # Agents are best described as Natural Language Understanding (NLU) modules that transform user requests into actionable data. You can include agents in your app, product, or service to determine user intent and respond to the user in a natural way. After you create an agent, you can add Intents, Entity Types, Flows, Fulfillments, Webhooks, and so on to manage the conversation flows.. - "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this agent. The settings exposed at the lower level overrides the settings exposed at the higher level. + "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this agent. The settings exposed at the lower level overrides the settings exposed at the higher level. "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. @@ -475,7 +475,7 @@

Method Details

An object of the form: { # Agents are best described as Natural Language Understanding (NLU) modules that transform user requests into actionable data. You can include agents in your app, product, or service to determine user intent and respond to the user in a natural way. After you create an agent, you can add Intents, Entity Types, Flows, Fulfillments, Webhooks, and so on to manage the conversation flows.. - "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this agent. The settings exposed at the lower level overrides the settings exposed at the higher level. + "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this agent. The settings exposed at the lower level overrides the settings exposed at the higher level. "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. "enableInteractionLogging": True or False, # If true, DF Interaction logging is currently enabled. "enableStackdriverLogging": True or False, # If true, StackDriver logging is currently enabled. diff --git a/docs/dyn/dlp_v2.organizations.inspectTemplates.html b/docs/dyn/dlp_v2.organizations.inspectTemplates.html index 212f7301114..ae7f1fc842f 100644 --- a/docs/dyn/dlp_v2.organizations.inspectTemplates.html +++ b/docs/dyn/dlp_v2.organizations.inspectTemplates.html @@ -134,9 +134,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -241,9 +241,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -289,9 +289,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -396,9 +396,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -466,9 +466,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -573,9 +573,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -631,9 +631,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -738,9 +738,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -803,9 +803,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -910,9 +910,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -957,9 +957,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -1064,9 +1064,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, diff --git a/docs/dyn/dlp_v2.organizations.locations.dlpJobs.html b/docs/dyn/dlp_v2.organizations.locations.dlpJobs.html index 2da1cb321fd..c2a59c1aafc 100644 --- a/docs/dyn/dlp_v2.organizations.locations.dlpJobs.html +++ b/docs/dyn/dlp_v2.organizations.locations.dlpJobs.html @@ -181,9 +181,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -288,9 +288,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -404,9 +404,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -511,9 +511,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, diff --git a/docs/dyn/dlp_v2.organizations.locations.inspectTemplates.html b/docs/dyn/dlp_v2.organizations.locations.inspectTemplates.html index a9868856e0c..6f128c68712 100644 --- a/docs/dyn/dlp_v2.organizations.locations.inspectTemplates.html +++ b/docs/dyn/dlp_v2.organizations.locations.inspectTemplates.html @@ -134,9 +134,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -241,9 +241,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -289,9 +289,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -396,9 +396,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -466,9 +466,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -573,9 +573,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -631,9 +631,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -738,9 +738,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -803,9 +803,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -910,9 +910,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -957,9 +957,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -1064,9 +1064,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, diff --git a/docs/dyn/dlp_v2.organizations.locations.jobTriggers.html b/docs/dyn/dlp_v2.organizations.locations.jobTriggers.html index 62d26c722ac..ba02db7f40d 100644 --- a/docs/dyn/dlp_v2.organizations.locations.jobTriggers.html +++ b/docs/dyn/dlp_v2.organizations.locations.jobTriggers.html @@ -176,9 +176,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -283,9 +283,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -467,9 +467,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -574,9 +574,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -780,9 +780,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -887,9 +887,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -1087,9 +1087,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -1194,9 +1194,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -1395,9 +1395,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -1502,9 +1502,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -1685,9 +1685,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -1792,9 +1792,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, diff --git a/docs/dyn/dlp_v2.projects.content.html b/docs/dyn/dlp_v2.projects.content.html index 5d4bc6980b1..6e234bef63f 100644 --- a/docs/dyn/dlp_v2.projects.content.html +++ b/docs/dyn/dlp_v2.projects.content.html @@ -927,9 +927,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -1034,9 +1034,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -1970,9 +1970,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -2077,9 +2077,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -2294,9 +2294,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -2401,9 +2401,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, diff --git a/docs/dyn/dlp_v2.projects.dlpJobs.html b/docs/dyn/dlp_v2.projects.dlpJobs.html index 8ed0824fd44..6a688c4fbc0 100644 --- a/docs/dyn/dlp_v2.projects.dlpJobs.html +++ b/docs/dyn/dlp_v2.projects.dlpJobs.html @@ -180,9 +180,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -287,9 +287,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -598,9 +598,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -705,9 +705,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -821,9 +821,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -928,9 +928,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -1588,9 +1588,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -1695,9 +1695,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -1811,9 +1811,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -1918,9 +1918,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -2572,9 +2572,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -2679,9 +2679,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -2795,9 +2795,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -2902,9 +2902,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, diff --git a/docs/dyn/dlp_v2.projects.image.html b/docs/dyn/dlp_v2.projects.image.html index 7c4a95c92bd..d1f320a3241 100644 --- a/docs/dyn/dlp_v2.projects.image.html +++ b/docs/dyn/dlp_v2.projects.image.html @@ -134,9 +134,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -241,9 +241,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, diff --git a/docs/dyn/dlp_v2.projects.inspectTemplates.html b/docs/dyn/dlp_v2.projects.inspectTemplates.html index 489bad1b183..91608f6f501 100644 --- a/docs/dyn/dlp_v2.projects.inspectTemplates.html +++ b/docs/dyn/dlp_v2.projects.inspectTemplates.html @@ -134,9 +134,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -241,9 +241,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -289,9 +289,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -396,9 +396,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -466,9 +466,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -573,9 +573,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -631,9 +631,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -738,9 +738,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -803,9 +803,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -910,9 +910,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -957,9 +957,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -1064,9 +1064,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, diff --git a/docs/dyn/dlp_v2.projects.jobTriggers.html b/docs/dyn/dlp_v2.projects.jobTriggers.html index c00327d61f7..ef2f99453b5 100644 --- a/docs/dyn/dlp_v2.projects.jobTriggers.html +++ b/docs/dyn/dlp_v2.projects.jobTriggers.html @@ -185,9 +185,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -292,9 +292,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -408,9 +408,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -515,9 +515,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -1157,9 +1157,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -1264,9 +1264,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -1448,9 +1448,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -1555,9 +1555,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -1761,9 +1761,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -1868,9 +1868,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -2068,9 +2068,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -2175,9 +2175,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -2376,9 +2376,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -2483,9 +2483,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -2666,9 +2666,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -2773,9 +2773,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, diff --git a/docs/dyn/dlp_v2.projects.locations.content.html b/docs/dyn/dlp_v2.projects.locations.content.html index 008d5230a4b..5dc093d25ae 100644 --- a/docs/dyn/dlp_v2.projects.locations.content.html +++ b/docs/dyn/dlp_v2.projects.locations.content.html @@ -927,9 +927,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -1034,9 +1034,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -1970,9 +1970,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -2077,9 +2077,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -2294,9 +2294,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -2401,9 +2401,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, diff --git a/docs/dyn/dlp_v2.projects.locations.dlpJobs.html b/docs/dyn/dlp_v2.projects.locations.dlpJobs.html index bf917acdd20..a93a8f9435d 100644 --- a/docs/dyn/dlp_v2.projects.locations.dlpJobs.html +++ b/docs/dyn/dlp_v2.projects.locations.dlpJobs.html @@ -186,9 +186,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -293,9 +293,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -604,9 +604,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -711,9 +711,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -827,9 +827,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -934,9 +934,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -1618,9 +1618,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -1725,9 +1725,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -1841,9 +1841,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -1948,9 +1948,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -2690,9 +2690,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -2797,9 +2797,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -2913,9 +2913,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -3020,9 +3020,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, diff --git a/docs/dyn/dlp_v2.projects.locations.image.html b/docs/dyn/dlp_v2.projects.locations.image.html index 02d7326ec1a..6d287f499b0 100644 --- a/docs/dyn/dlp_v2.projects.locations.image.html +++ b/docs/dyn/dlp_v2.projects.locations.image.html @@ -134,9 +134,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -241,9 +241,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, diff --git a/docs/dyn/dlp_v2.projects.locations.inspectTemplates.html b/docs/dyn/dlp_v2.projects.locations.inspectTemplates.html index de2dd9a3072..8c513936583 100644 --- a/docs/dyn/dlp_v2.projects.locations.inspectTemplates.html +++ b/docs/dyn/dlp_v2.projects.locations.inspectTemplates.html @@ -134,9 +134,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -241,9 +241,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -289,9 +289,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -396,9 +396,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -466,9 +466,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -573,9 +573,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -631,9 +631,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -738,9 +738,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -803,9 +803,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -910,9 +910,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -957,9 +957,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -1064,9 +1064,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, diff --git a/docs/dyn/dlp_v2.projects.locations.jobTriggers.html b/docs/dyn/dlp_v2.projects.locations.jobTriggers.html index 87b3dffb975..0a26028a0d9 100644 --- a/docs/dyn/dlp_v2.projects.locations.jobTriggers.html +++ b/docs/dyn/dlp_v2.projects.locations.jobTriggers.html @@ -188,9 +188,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -295,9 +295,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -411,9 +411,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -518,9 +518,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -1160,9 +1160,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -1267,9 +1267,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -1451,9 +1451,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -1558,9 +1558,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -1764,9 +1764,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -1871,9 +1871,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -2159,9 +2159,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -2266,9 +2266,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -2467,9 +2467,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -2574,9 +2574,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -2757,9 +2757,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, @@ -2864,9 +2864,9 @@

Method Details

"fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question. + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, }, diff --git a/docs/dyn/domains_v1.projects.locations.registrations.html b/docs/dyn/domains_v1.projects.locations.registrations.html index 68b95b27bc1..0eb1afe7018 100644 --- a/docs/dyn/domains_v1.projects.locations.registrations.html +++ b/docs/dyn/domains_v1.projects.locations.registrations.html @@ -167,7 +167,7 @@

Method Details

"email": "A String", # Required. Email address of the contact. "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`. "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. + "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -190,7 +190,7 @@

Method Details

"email": "A String", # Required. Email address of the contact. "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`. "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. + "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -212,7 +212,7 @@

Method Details

"email": "A String", # Required. Email address of the contact. "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`. "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. + "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -489,7 +489,7 @@

Method Details

"email": "A String", # Required. Email address of the contact. "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`. "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. + "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -512,7 +512,7 @@

Method Details

"email": "A String", # Required. Email address of the contact. "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`. "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. + "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -534,7 +534,7 @@

Method Details

"email": "A String", # Required. Email address of the contact. "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`. "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. + "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -612,7 +612,7 @@

Method Details

"email": "A String", # Required. Email address of the contact. "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`. "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. + "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -635,7 +635,7 @@

Method Details

"email": "A String", # Required. Email address of the contact. "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`. "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. + "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -657,7 +657,7 @@

Method Details

"email": "A String", # Required. Email address of the contact. "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`. "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. + "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -804,7 +804,7 @@

Method Details

"email": "A String", # Required. Email address of the contact. "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`. "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. + "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -827,7 +827,7 @@

Method Details

"email": "A String", # Required. Email address of the contact. "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`. "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. + "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -849,7 +849,7 @@

Method Details

"email": "A String", # Required. Email address of the contact. "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`. "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. + "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -927,7 +927,7 @@

Method Details

"email": "A String", # Required. Email address of the contact. "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`. "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. + "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -950,7 +950,7 @@

Method Details

"email": "A String", # Required. Email address of the contact. "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`. "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. + "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -972,7 +972,7 @@

Method Details

"email": "A String", # Required. Email address of the contact. "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`. "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. + "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -1031,7 +1031,7 @@

Method Details

"email": "A String", # Required. Email address of the contact. "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`. "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. + "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -1054,7 +1054,7 @@

Method Details

"email": "A String", # Required. Email address of the contact. "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`. "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. + "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -1076,7 +1076,7 @@

Method Details

"email": "A String", # Required. Email address of the contact. "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`. "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. + "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -1154,7 +1154,7 @@

Method Details

"email": "A String", # Required. Email address of the contact. "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`. "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. + "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -1177,7 +1177,7 @@

Method Details

"email": "A String", # Required. Email address of the contact. "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`. "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. + "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -1199,7 +1199,7 @@

Method Details

"email": "A String", # Required. Email address of the contact. "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`. "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. + "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -1278,7 +1278,7 @@

Method Details

"email": "A String", # Required. Email address of the contact. "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`. "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. + "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -1301,7 +1301,7 @@

Method Details

"email": "A String", # Required. Email address of the contact. "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`. "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. + "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -1323,7 +1323,7 @@

Method Details

"email": "A String", # Required. Email address of the contact. "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`. "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. + "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -1401,7 +1401,7 @@

Method Details

"email": "A String", # Required. Email address of the contact. "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`. "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. + "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -1424,7 +1424,7 @@

Method Details

"email": "A String", # Required. Email address of the contact. "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`. "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. + "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -1446,7 +1446,7 @@

Method Details

"email": "A String", # Required. Email address of the contact. "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`. "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. + "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -1842,7 +1842,7 @@

Method Details

"email": "A String", # Required. Email address of the contact. "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`. "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. + "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -1865,7 +1865,7 @@

Method Details

"email": "A String", # Required. Email address of the contact. "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`. "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. + "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -1887,7 +1887,7 @@

Method Details

"email": "A String", # Required. Email address of the contact. "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`. "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. + "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -1965,7 +1965,7 @@

Method Details

"email": "A String", # Required. Email address of the contact. "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`. "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. + "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -1988,7 +1988,7 @@

Method Details

"email": "A String", # Required. Email address of the contact. "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`. "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. + "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -2010,7 +2010,7 @@

Method Details

"email": "A String", # Required. Email address of the contact. "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`. "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. + "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], diff --git a/docs/dyn/domains_v1alpha2.projects.locations.registrations.html b/docs/dyn/domains_v1alpha2.projects.locations.registrations.html index 0ae21ba6674..d208707a4e7 100644 --- a/docs/dyn/domains_v1alpha2.projects.locations.registrations.html +++ b/docs/dyn/domains_v1alpha2.projects.locations.registrations.html @@ -167,7 +167,7 @@

Method Details

"email": "A String", # Required. Email address of the contact. "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`. "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. + "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -190,7 +190,7 @@

Method Details

"email": "A String", # Required. Email address of the contact. "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`. "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. + "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -212,7 +212,7 @@

Method Details

"email": "A String", # Required. Email address of the contact. "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`. "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. + "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -489,7 +489,7 @@

Method Details

"email": "A String", # Required. Email address of the contact. "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`. "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. + "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -512,7 +512,7 @@

Method Details

"email": "A String", # Required. Email address of the contact. "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`. "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. + "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -534,7 +534,7 @@

Method Details

"email": "A String", # Required. Email address of the contact. "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`. "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. + "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -612,7 +612,7 @@

Method Details

"email": "A String", # Required. Email address of the contact. "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`. "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. + "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -635,7 +635,7 @@

Method Details

"email": "A String", # Required. Email address of the contact. "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`. "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. + "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -657,7 +657,7 @@

Method Details

"email": "A String", # Required. Email address of the contact. "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`. "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. + "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -804,7 +804,7 @@

Method Details

"email": "A String", # Required. Email address of the contact. "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`. "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. + "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -827,7 +827,7 @@

Method Details

"email": "A String", # Required. Email address of the contact. "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`. "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. + "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -849,7 +849,7 @@

Method Details

"email": "A String", # Required. Email address of the contact. "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`. "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. + "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -927,7 +927,7 @@

Method Details

"email": "A String", # Required. Email address of the contact. "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`. "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. + "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -950,7 +950,7 @@

Method Details

"email": "A String", # Required. Email address of the contact. "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`. "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. + "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -972,7 +972,7 @@

Method Details

"email": "A String", # Required. Email address of the contact. "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`. "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. + "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -1031,7 +1031,7 @@

Method Details

"email": "A String", # Required. Email address of the contact. "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`. "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. + "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -1054,7 +1054,7 @@

Method Details

"email": "A String", # Required. Email address of the contact. "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`. "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. + "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -1076,7 +1076,7 @@

Method Details

"email": "A String", # Required. Email address of the contact. "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`. "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. + "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -1154,7 +1154,7 @@

Method Details

"email": "A String", # Required. Email address of the contact. "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`. "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. + "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -1177,7 +1177,7 @@

Method Details

"email": "A String", # Required. Email address of the contact. "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`. "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. + "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -1199,7 +1199,7 @@

Method Details

"email": "A String", # Required. Email address of the contact. "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`. "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. + "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -1278,7 +1278,7 @@

Method Details

"email": "A String", # Required. Email address of the contact. "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`. "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. + "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -1301,7 +1301,7 @@

Method Details

"email": "A String", # Required. Email address of the contact. "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`. "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. + "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -1323,7 +1323,7 @@

Method Details

"email": "A String", # Required. Email address of the contact. "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`. "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. + "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -1401,7 +1401,7 @@

Method Details

"email": "A String", # Required. Email address of the contact. "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`. "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. + "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -1424,7 +1424,7 @@

Method Details

"email": "A String", # Required. Email address of the contact. "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`. "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. + "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -1446,7 +1446,7 @@

Method Details

"email": "A String", # Required. Email address of the contact. "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`. "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. + "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -1842,7 +1842,7 @@

Method Details

"email": "A String", # Required. Email address of the contact. "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`. "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. + "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -1865,7 +1865,7 @@

Method Details

"email": "A String", # Required. Email address of the contact. "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`. "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. + "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -1887,7 +1887,7 @@

Method Details

"email": "A String", # Required. Email address of the contact. "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`. "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. + "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -1965,7 +1965,7 @@

Method Details

"email": "A String", # Required. Email address of the contact. "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`. "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. + "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -1988,7 +1988,7 @@

Method Details

"email": "A String", # Required. Email address of the contact. "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`. "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. + "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -2010,7 +2010,7 @@

Method Details

"email": "A String", # Required. Email address of the contact. "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`. "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. + "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], diff --git a/docs/dyn/domains_v1beta1.projects.locations.registrations.html b/docs/dyn/domains_v1beta1.projects.locations.registrations.html index 7339f4319eb..0c321e29274 100644 --- a/docs/dyn/domains_v1beta1.projects.locations.registrations.html +++ b/docs/dyn/domains_v1beta1.projects.locations.registrations.html @@ -167,7 +167,7 @@

Method Details

"email": "A String", # Required. Email address of the contact. "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`. "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. + "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -190,7 +190,7 @@

Method Details

"email": "A String", # Required. Email address of the contact. "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`. "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. + "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -212,7 +212,7 @@

Method Details

"email": "A String", # Required. Email address of the contact. "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`. "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. + "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -489,7 +489,7 @@

Method Details

"email": "A String", # Required. Email address of the contact. "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`. "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. + "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -512,7 +512,7 @@

Method Details

"email": "A String", # Required. Email address of the contact. "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`. "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. + "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -534,7 +534,7 @@

Method Details

"email": "A String", # Required. Email address of the contact. "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`. "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. + "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -612,7 +612,7 @@

Method Details

"email": "A String", # Required. Email address of the contact. "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`. "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. + "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -635,7 +635,7 @@

Method Details

"email": "A String", # Required. Email address of the contact. "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`. "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. + "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -657,7 +657,7 @@

Method Details

"email": "A String", # Required. Email address of the contact. "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`. "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. + "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -804,7 +804,7 @@

Method Details

"email": "A String", # Required. Email address of the contact. "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`. "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. + "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -827,7 +827,7 @@

Method Details

"email": "A String", # Required. Email address of the contact. "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`. "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. + "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -849,7 +849,7 @@

Method Details

"email": "A String", # Required. Email address of the contact. "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`. "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. + "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -927,7 +927,7 @@

Method Details

"email": "A String", # Required. Email address of the contact. "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`. "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. + "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -950,7 +950,7 @@

Method Details

"email": "A String", # Required. Email address of the contact. "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`. "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. + "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -972,7 +972,7 @@

Method Details

"email": "A String", # Required. Email address of the contact. "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`. "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. + "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -1031,7 +1031,7 @@

Method Details

"email": "A String", # Required. Email address of the contact. "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`. "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. + "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -1054,7 +1054,7 @@

Method Details

"email": "A String", # Required. Email address of the contact. "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`. "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. + "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -1076,7 +1076,7 @@

Method Details

"email": "A String", # Required. Email address of the contact. "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`. "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. + "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -1154,7 +1154,7 @@

Method Details

"email": "A String", # Required. Email address of the contact. "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`. "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. + "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -1177,7 +1177,7 @@

Method Details

"email": "A String", # Required. Email address of the contact. "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`. "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. + "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -1199,7 +1199,7 @@

Method Details

"email": "A String", # Required. Email address of the contact. "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`. "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. + "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -1278,7 +1278,7 @@

Method Details

"email": "A String", # Required. Email address of the contact. "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`. "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. + "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -1301,7 +1301,7 @@

Method Details

"email": "A String", # Required. Email address of the contact. "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`. "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. + "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -1323,7 +1323,7 @@

Method Details

"email": "A String", # Required. Email address of the contact. "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`. "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. + "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -1401,7 +1401,7 @@

Method Details

"email": "A String", # Required. Email address of the contact. "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`. "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. + "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -1424,7 +1424,7 @@

Method Details

"email": "A String", # Required. Email address of the contact. "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`. "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. + "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -1446,7 +1446,7 @@

Method Details

"email": "A String", # Required. Email address of the contact. "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`. "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. + "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -1842,7 +1842,7 @@

Method Details

"email": "A String", # Required. Email address of the contact. "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`. "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. + "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -1865,7 +1865,7 @@

Method Details

"email": "A String", # Required. Email address of the contact. "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`. "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. + "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -1887,7 +1887,7 @@

Method Details

"email": "A String", # Required. Email address of the contact. "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`. "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. + "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -1965,7 +1965,7 @@

Method Details

"email": "A String", # Required. Email address of the contact. "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`. "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. + "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -1988,7 +1988,7 @@

Method Details

"email": "A String", # Required. Email address of the contact. "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`. "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. + "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -2010,7 +2010,7 @@

Method Details

"email": "A String", # Required. Email address of the contact. "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`. "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`. - "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. + "postalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], diff --git a/docs/dyn/doubleclickbidmanager_v2.queries.html b/docs/dyn/doubleclickbidmanager_v2.queries.html index 4c988fb265d..0675eeb595d 100644 --- a/docs/dyn/doubleclickbidmanager_v2.queries.html +++ b/docs/dyn/doubleclickbidmanager_v2.queries.html @@ -87,13 +87,13 @@

Instance Methods

Creates a query.

delete(queryId, x__xgafv=None)

-

Deletes a stored query as well as the associated stored reports.

+

Deletes a query as well as the associated reports.

get(queryId, x__xgafv=None)

-

Retrieves a stored query.

+

Retrieves a query.

list(orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

-

Retrieves stored queries.

+

Lists queries created by the current user.

list_next()

Retrieves the next page of results.

@@ -116,7 +116,7 @@

Method Details

{ # Represents a query. "metadata": { # Query metadata. # Query metadata. - "dataRange": { # Report data range. # Range of report data. + "dataRange": { # Report data range. # Range of report data. All reports will be based on the same time zone as used by the advertiser. "customEndDate": { # 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 # The ending date for the data that is shown in the report. Note, `customEndDate` is required if `range` is `CUSTOM_DATES` and ignored otherwise. "day": 42, # 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. "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. @@ -131,7 +131,7 @@

Method Details

}, "format": "A String", # Format of the generated report. "sendNotification": True or False, # Whether to send an email notification when a report is ready. Defaults to false. - "shareEmailAddress": [ # List of email addresses which are sent email notifications when the report is finished. Separate from `sendNotification`. + "shareEmailAddress": [ # List of email addresses which are sent email notifications when the report is finished. Separate from send_notification. "A String", ], "title": "A String", # Query title. It is used to name the reports generated from this query. @@ -161,10 +161,10 @@

Method Details

{ # DisjunctiveMatchStatement that OR's all contained filters. "eventFilters": [ # Filters. There is a limit of 100 filters that can be set per disjunctive match statement. { # Defines the type of filter to be applied to the path, a DV360 event dimension filter. - "dimensionFilter": { # Dimension Filter on path events. # Filter on a dimension. + "dimensionFilter": { # Dimension filter on path events. # Filter on a dimension. "filter": "A String", # Dimension the filter is applied to. - "match": "A String", # Indicates how the filter should be matched to the value. - "values": [ # Value to filter on. + "match": "A String", # Match logic of the filter. + "values": [ # Values to filter on. "A String", ], }, @@ -180,24 +180,24 @@

Method Details

{ # Path filters specify which paths to include in a report. A path is the result of combining DV360 events based on User ID to create a workflow of users' actions. When a path filter is set, the resulting report will only include paths that match the specified event at the specified position. All other paths will be excluded. "eventFilters": [ # Filter on an event to be applied to some part of the path. { # Defines the type of filter to be applied to the path, a DV360 event dimension filter. - "dimensionFilter": { # Dimension Filter on path events. # Filter on a dimension. + "dimensionFilter": { # Dimension filter on path events. # Filter on a dimension. "filter": "A String", # Dimension the filter is applied to. - "match": "A String", # Indicates how the filter should be matched to the value. - "values": [ # Value to filter on. + "match": "A String", # Match logic of the filter. + "values": [ # Values to filter on. "A String", ], }, }, ], - "pathMatchPosition": "A String", # Indicates the position of the path the filter should match to (first, last, or any event in path). + "pathMatchPosition": "A String", # The position of the path the filter should match to (first, last, or any event in path). }, ], }, }, - "type": "A String", # Report type. + "type": "A String", # The type of the report. The type of the report will dictate what dimesions, filters, and metrics can be used. }, "queryId": "A String", # Output only. Query ID. - "schedule": { # Information on how frequently and when to run a query. # Information on how often and when to run a query. + "schedule": { # Information on when and how frequently to run a query. # Information on how often and when to run a query. If `ONE_TIME` is set to the frequency field, the query will only be run at the time of creation. "endDate": { # 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 # Date to periodically run the query until. Not applicable to `ONE_TIME` frequency. "day": 42, # 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. "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. @@ -223,7 +223,7 @@

Method Details

{ # Represents a query. "metadata": { # Query metadata. # Query metadata. - "dataRange": { # Report data range. # Range of report data. + "dataRange": { # Report data range. # Range of report data. All reports will be based on the same time zone as used by the advertiser. "customEndDate": { # 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 # The ending date for the data that is shown in the report. Note, `customEndDate` is required if `range` is `CUSTOM_DATES` and ignored otherwise. "day": 42, # 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. "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. @@ -238,7 +238,7 @@

Method Details

}, "format": "A String", # Format of the generated report. "sendNotification": True or False, # Whether to send an email notification when a report is ready. Defaults to false. - "shareEmailAddress": [ # List of email addresses which are sent email notifications when the report is finished. Separate from `sendNotification`. + "shareEmailAddress": [ # List of email addresses which are sent email notifications when the report is finished. Separate from send_notification. "A String", ], "title": "A String", # Query title. It is used to name the reports generated from this query. @@ -268,10 +268,10 @@

Method Details

{ # DisjunctiveMatchStatement that OR's all contained filters. "eventFilters": [ # Filters. There is a limit of 100 filters that can be set per disjunctive match statement. { # Defines the type of filter to be applied to the path, a DV360 event dimension filter. - "dimensionFilter": { # Dimension Filter on path events. # Filter on a dimension. + "dimensionFilter": { # Dimension filter on path events. # Filter on a dimension. "filter": "A String", # Dimension the filter is applied to. - "match": "A String", # Indicates how the filter should be matched to the value. - "values": [ # Value to filter on. + "match": "A String", # Match logic of the filter. + "values": [ # Values to filter on. "A String", ], }, @@ -287,24 +287,24 @@

Method Details

{ # Path filters specify which paths to include in a report. A path is the result of combining DV360 events based on User ID to create a workflow of users' actions. When a path filter is set, the resulting report will only include paths that match the specified event at the specified position. All other paths will be excluded. "eventFilters": [ # Filter on an event to be applied to some part of the path. { # Defines the type of filter to be applied to the path, a DV360 event dimension filter. - "dimensionFilter": { # Dimension Filter on path events. # Filter on a dimension. + "dimensionFilter": { # Dimension filter on path events. # Filter on a dimension. "filter": "A String", # Dimension the filter is applied to. - "match": "A String", # Indicates how the filter should be matched to the value. - "values": [ # Value to filter on. + "match": "A String", # Match logic of the filter. + "values": [ # Values to filter on. "A String", ], }, }, ], - "pathMatchPosition": "A String", # Indicates the position of the path the filter should match to (first, last, or any event in path). + "pathMatchPosition": "A String", # The position of the path the filter should match to (first, last, or any event in path). }, ], }, }, - "type": "A String", # Report type. + "type": "A String", # The type of the report. The type of the report will dictate what dimesions, filters, and metrics can be used. }, "queryId": "A String", # Output only. Query ID. - "schedule": { # Information on how frequently and when to run a query. # Information on how often and when to run a query. + "schedule": { # Information on when and how frequently to run a query. # Information on how often and when to run a query. If `ONE_TIME` is set to the frequency field, the query will only be run at the time of creation. "endDate": { # 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 # Date to periodically run the query until. Not applicable to `ONE_TIME` frequency. "day": 42, # 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. "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. @@ -323,10 +323,10 @@

Method Details

delete(queryId, x__xgafv=None) -
Deletes a stored query as well as the associated stored reports.
+  
Deletes a query as well as the associated reports.
 
 Args:
-  queryId: string, Required. Query ID to delete. (required)
+  queryId: string, Required. ID of query to delete. (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -336,10 +336,10 @@ 

Method Details

get(queryId, x__xgafv=None) -
Retrieves a stored query.
+  
Retrieves a query.
 
 Args:
-  queryId: string, Required. Query ID to retrieve. (required)
+  queryId: string, Required. ID of query to retrieve. (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -350,7 +350,7 @@ 

Method Details

{ # Represents a query. "metadata": { # Query metadata. # Query metadata. - "dataRange": { # Report data range. # Range of report data. + "dataRange": { # Report data range. # Range of report data. All reports will be based on the same time zone as used by the advertiser. "customEndDate": { # 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 # The ending date for the data that is shown in the report. Note, `customEndDate` is required if `range` is `CUSTOM_DATES` and ignored otherwise. "day": 42, # 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. "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. @@ -365,7 +365,7 @@

Method Details

}, "format": "A String", # Format of the generated report. "sendNotification": True or False, # Whether to send an email notification when a report is ready. Defaults to false. - "shareEmailAddress": [ # List of email addresses which are sent email notifications when the report is finished. Separate from `sendNotification`. + "shareEmailAddress": [ # List of email addresses which are sent email notifications when the report is finished. Separate from send_notification. "A String", ], "title": "A String", # Query title. It is used to name the reports generated from this query. @@ -395,10 +395,10 @@

Method Details

{ # DisjunctiveMatchStatement that OR's all contained filters. "eventFilters": [ # Filters. There is a limit of 100 filters that can be set per disjunctive match statement. { # Defines the type of filter to be applied to the path, a DV360 event dimension filter. - "dimensionFilter": { # Dimension Filter on path events. # Filter on a dimension. + "dimensionFilter": { # Dimension filter on path events. # Filter on a dimension. "filter": "A String", # Dimension the filter is applied to. - "match": "A String", # Indicates how the filter should be matched to the value. - "values": [ # Value to filter on. + "match": "A String", # Match logic of the filter. + "values": [ # Values to filter on. "A String", ], }, @@ -414,24 +414,24 @@

Method Details

{ # Path filters specify which paths to include in a report. A path is the result of combining DV360 events based on User ID to create a workflow of users' actions. When a path filter is set, the resulting report will only include paths that match the specified event at the specified position. All other paths will be excluded. "eventFilters": [ # Filter on an event to be applied to some part of the path. { # Defines the type of filter to be applied to the path, a DV360 event dimension filter. - "dimensionFilter": { # Dimension Filter on path events. # Filter on a dimension. + "dimensionFilter": { # Dimension filter on path events. # Filter on a dimension. "filter": "A String", # Dimension the filter is applied to. - "match": "A String", # Indicates how the filter should be matched to the value. - "values": [ # Value to filter on. + "match": "A String", # Match logic of the filter. + "values": [ # Values to filter on. "A String", ], }, }, ], - "pathMatchPosition": "A String", # Indicates the position of the path the filter should match to (first, last, or any event in path). + "pathMatchPosition": "A String", # The position of the path the filter should match to (first, last, or any event in path). }, ], }, }, - "type": "A String", # Report type. + "type": "A String", # The type of the report. The type of the report will dictate what dimesions, filters, and metrics can be used. }, "queryId": "A String", # Output only. Query ID. - "schedule": { # Information on how frequently and when to run a query. # Information on how often and when to run a query. + "schedule": { # Information on when and how frequently to run a query. # Information on how often and when to run a query. If `ONE_TIME` is set to the frequency field, the query will only be run at the time of creation. "endDate": { # 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 # Date to periodically run the query until. Not applicable to `ONE_TIME` frequency. "day": 42, # 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. "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. @@ -450,10 +450,10 @@

Method Details

list(orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) -
Retrieves stored queries.
+  
Lists queries created by the current user.
 
 Args:
-  orderBy: string, Name of a field used to order results. The default sorting order is ascending. To specify descending order for a field, append a " desc" suffix. For example "metadata.title desc". Sorting is only supported for the following fields: * queryId * metadata.title
+  orderBy: string, Name of a field used to order results. The default sorting order is ascending. To specify descending order for a field, append a " desc" suffix. For example "metadata.title desc". Sorting is only supported for the following fields: * `queryId` * `metadata.title`
   pageSize: integer, Maximum number of results per page. Must be between `1` and `100`. Defaults to `100` if unspecified.
   pageToken: string, A page token, received from a previous list call. Provide this to retrieve the subsequent page of queries.
   x__xgafv: string, V1 error format.
@@ -464,12 +464,12 @@ 

Method Details

Returns: An object of the form: - { # Represents a list of queries. - "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page of queries. If this field is omitted, there are no subsequent pages. - "queries": [ # Retrieved queries. + { + "nextPageToken": "A String", # A token, which can be sent as page_token to retrieve the next page of queries. If this field is omitted, there are no subsequent pages. + "queries": [ # The list of queries. { # Represents a query. "metadata": { # Query metadata. # Query metadata. - "dataRange": { # Report data range. # Range of report data. + "dataRange": { # Report data range. # Range of report data. All reports will be based on the same time zone as used by the advertiser. "customEndDate": { # 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 # The ending date for the data that is shown in the report. Note, `customEndDate` is required if `range` is `CUSTOM_DATES` and ignored otherwise. "day": 42, # 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. "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. @@ -484,7 +484,7 @@

Method Details

}, "format": "A String", # Format of the generated report. "sendNotification": True or False, # Whether to send an email notification when a report is ready. Defaults to false. - "shareEmailAddress": [ # List of email addresses which are sent email notifications when the report is finished. Separate from `sendNotification`. + "shareEmailAddress": [ # List of email addresses which are sent email notifications when the report is finished. Separate from send_notification. "A String", ], "title": "A String", # Query title. It is used to name the reports generated from this query. @@ -514,10 +514,10 @@

Method Details

{ # DisjunctiveMatchStatement that OR's all contained filters. "eventFilters": [ # Filters. There is a limit of 100 filters that can be set per disjunctive match statement. { # Defines the type of filter to be applied to the path, a DV360 event dimension filter. - "dimensionFilter": { # Dimension Filter on path events. # Filter on a dimension. + "dimensionFilter": { # Dimension filter on path events. # Filter on a dimension. "filter": "A String", # Dimension the filter is applied to. - "match": "A String", # Indicates how the filter should be matched to the value. - "values": [ # Value to filter on. + "match": "A String", # Match logic of the filter. + "values": [ # Values to filter on. "A String", ], }, @@ -533,24 +533,24 @@

Method Details

{ # Path filters specify which paths to include in a report. A path is the result of combining DV360 events based on User ID to create a workflow of users' actions. When a path filter is set, the resulting report will only include paths that match the specified event at the specified position. All other paths will be excluded. "eventFilters": [ # Filter on an event to be applied to some part of the path. { # Defines the type of filter to be applied to the path, a DV360 event dimension filter. - "dimensionFilter": { # Dimension Filter on path events. # Filter on a dimension. + "dimensionFilter": { # Dimension filter on path events. # Filter on a dimension. "filter": "A String", # Dimension the filter is applied to. - "match": "A String", # Indicates how the filter should be matched to the value. - "values": [ # Value to filter on. + "match": "A String", # Match logic of the filter. + "values": [ # Values to filter on. "A String", ], }, }, ], - "pathMatchPosition": "A String", # Indicates the position of the path the filter should match to (first, last, or any event in path). + "pathMatchPosition": "A String", # The position of the path the filter should match to (first, last, or any event in path). }, ], }, }, - "type": "A String", # Report type. + "type": "A String", # The type of the report. The type of the report will dictate what dimesions, filters, and metrics can be used. }, "queryId": "A String", # Output only. Query ID. - "schedule": { # Information on how frequently and when to run a query. # Information on how often and when to run a query. + "schedule": { # Information on when and how frequently to run a query. # Information on how often and when to run a query. If `ONE_TIME` is set to the frequency field, the query will only be run at the time of creation. "endDate": { # 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 # Date to periodically run the query until. Not applicable to `ONE_TIME` frequency. "day": 42, # 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. "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. @@ -588,7 +588,7 @@

Method Details

Runs a stored query to generate a report.
 
 Args:
-  queryId: string, Required. Query ID to run. (required)
+  queryId: string, Required. ID of query to run. (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -665,10 +665,10 @@ 

Method Details

{ # DisjunctiveMatchStatement that OR's all contained filters. "eventFilters": [ # Filters. There is a limit of 100 filters that can be set per disjunctive match statement. { # Defines the type of filter to be applied to the path, a DV360 event dimension filter. - "dimensionFilter": { # Dimension Filter on path events. # Filter on a dimension. + "dimensionFilter": { # Dimension filter on path events. # Filter on a dimension. "filter": "A String", # Dimension the filter is applied to. - "match": "A String", # Indicates how the filter should be matched to the value. - "values": [ # Value to filter on. + "match": "A String", # Match logic of the filter. + "values": [ # Values to filter on. "A String", ], }, @@ -684,21 +684,21 @@

Method Details

{ # Path filters specify which paths to include in a report. A path is the result of combining DV360 events based on User ID to create a workflow of users' actions. When a path filter is set, the resulting report will only include paths that match the specified event at the specified position. All other paths will be excluded. "eventFilters": [ # Filter on an event to be applied to some part of the path. { # Defines the type of filter to be applied to the path, a DV360 event dimension filter. - "dimensionFilter": { # Dimension Filter on path events. # Filter on a dimension. + "dimensionFilter": { # Dimension filter on path events. # Filter on a dimension. "filter": "A String", # Dimension the filter is applied to. - "match": "A String", # Indicates how the filter should be matched to the value. - "values": [ # Value to filter on. + "match": "A String", # Match logic of the filter. + "values": [ # Values to filter on. "A String", ], }, }, ], - "pathMatchPosition": "A String", # Indicates the position of the path the filter should match to (first, last, or any event in path). + "pathMatchPosition": "A String", # The position of the path the filter should match to (first, last, or any event in path). }, ], }, }, - "type": "A String", # Report type. + "type": "A String", # The type of the report. The type of the report will dictate what dimesions, filters, and metrics can be used. }, }
diff --git a/docs/dyn/doubleclickbidmanager_v2.queries.reports.html b/docs/dyn/doubleclickbidmanager_v2.queries.reports.html index 2b9891c33a4..598bd59f6d0 100644 --- a/docs/dyn/doubleclickbidmanager_v2.queries.reports.html +++ b/docs/dyn/doubleclickbidmanager_v2.queries.reports.html @@ -79,10 +79,10 @@

Instance Methods

Close httplib2 connections.

get(queryId, reportId, x__xgafv=None)

-

Retrieves a stored report.

+

Retrieves a report.

list(queryId, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

-

Lists reports.

+

Lists reports associated with a query.

list_next()

Retrieves the next page of results.

@@ -94,7 +94,7 @@

Method Details

get(queryId, reportId, x__xgafv=None) -
Retrieves a stored report.
+  
Retrieves a report.
 
 Args:
   queryId: string, Required. ID of the query the report is associated with. (required)
@@ -155,10 +155,10 @@ 

Method Details

{ # DisjunctiveMatchStatement that OR's all contained filters. "eventFilters": [ # Filters. There is a limit of 100 filters that can be set per disjunctive match statement. { # Defines the type of filter to be applied to the path, a DV360 event dimension filter. - "dimensionFilter": { # Dimension Filter on path events. # Filter on a dimension. + "dimensionFilter": { # Dimension filter on path events. # Filter on a dimension. "filter": "A String", # Dimension the filter is applied to. - "match": "A String", # Indicates how the filter should be matched to the value. - "values": [ # Value to filter on. + "match": "A String", # Match logic of the filter. + "values": [ # Values to filter on. "A String", ], }, @@ -174,32 +174,32 @@

Method Details

{ # Path filters specify which paths to include in a report. A path is the result of combining DV360 events based on User ID to create a workflow of users' actions. When a path filter is set, the resulting report will only include paths that match the specified event at the specified position. All other paths will be excluded. "eventFilters": [ # Filter on an event to be applied to some part of the path. { # Defines the type of filter to be applied to the path, a DV360 event dimension filter. - "dimensionFilter": { # Dimension Filter on path events. # Filter on a dimension. + "dimensionFilter": { # Dimension filter on path events. # Filter on a dimension. "filter": "A String", # Dimension the filter is applied to. - "match": "A String", # Indicates how the filter should be matched to the value. - "values": [ # Value to filter on. + "match": "A String", # Match logic of the filter. + "values": [ # Values to filter on. "A String", ], }, }, ], - "pathMatchPosition": "A String", # Indicates the position of the path the filter should match to (first, last, or any event in path). + "pathMatchPosition": "A String", # The position of the path the filter should match to (first, last, or any event in path). }, ], }, }, - "type": "A String", # Report type. + "type": "A String", # The type of the report. The type of the report will dictate what dimesions, filters, and metrics can be used. }, }
list(queryId, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists reports.
+  
Lists reports associated with a query.
 
 Args:
-  queryId: string, Required. Query ID with which the reports are associated. (required)
-  orderBy: string, Name of a field used to order results. The default sorting order is ascending. To specify descending order for a field, append a " desc" suffix. For example "key.reportId desc". Sorting is only supported for the following fields: * key.reportId
+  queryId: string, Required. ID of the query with which the reports are associated. (required)
+  orderBy: string, Name of a field used to order results. The default sorting order is ascending. To specify descending order for a field, append a " desc" suffix. For example "key.reportId desc". Sorting is only supported for the following fields: * `key.reportId`
   pageSize: integer, Maximum number of results per page. Must be between `1` and `100`. Defaults to `100` if unspecified.
   pageToken: string, A page token, received from a previous list call. Provide this to retrieve the subsequent page of reports.
   x__xgafv: string, V1 error format.
@@ -210,8 +210,8 @@ 

Method Details

Returns: An object of the form: - { # Represents a list of reports. - "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page of reports. If this field is omitted, there are no subsequent pages. + { + "nextPageToken": "A String", # A token, which can be sent as page_token to retrieve the next page of reports. If this field is omitted, there are no subsequent pages. "reports": [ # Retrieved reports. { # Represents a report. "key": { # Key used to identify a report. # Key used to identify a report. @@ -261,10 +261,10 @@

Method Details

{ # DisjunctiveMatchStatement that OR's all contained filters. "eventFilters": [ # Filters. There is a limit of 100 filters that can be set per disjunctive match statement. { # Defines the type of filter to be applied to the path, a DV360 event dimension filter. - "dimensionFilter": { # Dimension Filter on path events. # Filter on a dimension. + "dimensionFilter": { # Dimension filter on path events. # Filter on a dimension. "filter": "A String", # Dimension the filter is applied to. - "match": "A String", # Indicates how the filter should be matched to the value. - "values": [ # Value to filter on. + "match": "A String", # Match logic of the filter. + "values": [ # Values to filter on. "A String", ], }, @@ -280,21 +280,21 @@

Method Details

{ # Path filters specify which paths to include in a report. A path is the result of combining DV360 events based on User ID to create a workflow of users' actions. When a path filter is set, the resulting report will only include paths that match the specified event at the specified position. All other paths will be excluded. "eventFilters": [ # Filter on an event to be applied to some part of the path. { # Defines the type of filter to be applied to the path, a DV360 event dimension filter. - "dimensionFilter": { # Dimension Filter on path events. # Filter on a dimension. + "dimensionFilter": { # Dimension filter on path events. # Filter on a dimension. "filter": "A String", # Dimension the filter is applied to. - "match": "A String", # Indicates how the filter should be matched to the value. - "values": [ # Value to filter on. + "match": "A String", # Match logic of the filter. + "values": [ # Values to filter on. "A String", ], }, }, ], - "pathMatchPosition": "A String", # Indicates the position of the path the filter should match to (first, last, or any event in path). + "pathMatchPosition": "A String", # The position of the path the filter should match to (first, last, or any event in path). }, ], }, }, - "type": "A String", # Report type. + "type": "A String", # The type of the report. The type of the report will dictate what dimesions, filters, and metrics can be used. }, }, ], diff --git a/docs/dyn/firestore_v1beta1.projects.databases.documents.html b/docs/dyn/firestore_v1beta1.projects.databases.documents.html index 453e42a5794..1cb370d1388 100644 --- a/docs/dyn/firestore_v1beta1.projects.databases.documents.html +++ b/docs/dyn/firestore_v1beta1.projects.databases.documents.html @@ -181,11 +181,7 @@

Method Details

"createTime": "A String", # Output only. The time at which the document was created. This value increases monotonically when a document is deleted then recreated. It can also be compared to values from other documents and the `read_time` of a query. "fields": { # The document's fields. The map keys represent field names. A simple field name contains only characters `a` to `z`, `A` to `Z`, `0` to `9`, or `_`, and must not start with `0` to `9`. For example, `foo_bar_17`. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. Field paths may be used in other contexts to refer to structured fields defined here. For `map_value`, the field path is represented by the simple or quoted field names of the containing fields, delimited by `.`. For example, the structured field `"foo" : { map_value: { "x&y" : { string_value: "hello" }}}` would be represented by the field path `foo.x&y`. Within a field path, a quoted field name starts and ends with `` ` `` and may contain any character. Some characters, including `` ` ``, must be escaped using a `\`. For example, `` `x&y` `` represents `x&y` and `` `bak\`tik` `` represents `` bak`tik ``. "a_key": { # A message that can hold any of the supported value types. - "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. - "values": [ # Values in the array. - # Object with schema name: Value - ], - }, + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -240,16 +236,31 @@

Method Details

{ # A transformation of a field of the document. "appendMissingElements": { # An array value. # Append the given elements in order if they are not already present in the current field value. If the field is not an array, or if the field does not yet exist, it is first set to the empty array. Equivalent numbers of different types (e.g. 3L and 3.0) are considered equal when checking if a value is missing. NaN is equal to NaN, and Null is equal to Null. If the input contains multiple equivalent values, only the first will be considered. The corresponding transform_result will be the null value. "values": [ # Values in the array. - # Object with schema name: Value + { # A message that can hold any of the supported value types. + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "booleanValue": True or False, # A boolean value. + "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. + "doubleValue": 3.14, # A double value. + "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + "integerValue": "A String", # An integer value. + "mapValue": { # A map value. # A map value. + "fields": { # The map's fields. The map keys represent field names. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. + "a_key": # Object with schema name: Value + }, + }, + "nullValue": "A String", # A null value. + "referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. + "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. + "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + }, ], }, "fieldPath": "A String", # The path of the field. See Document.fields for the field path syntax reference. "increment": { # A message that can hold any of the supported value types. # Adds the given value to the field's current value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the given value. If either of the given value or the current field value are doubles, both values will be interpreted as doubles. Double arithmetic and representation of double values follow IEEE 754 semantics. If there is positive/negative integer overflow, the field is resolved to the largest magnitude positive/negative integer. - "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. - "values": [ # Values in the array. - # Object with schema name: Value - ], - }, + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -269,11 +280,7 @@

Method Details

"timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. }, "maximum": { # A message that can hold any of the supported value types. # Sets the field to the maximum of its current value and the given value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the given value. If a maximum operation is applied where the field and the input value are of mixed types (that is - one is an integer and one is a double) the field takes on the type of the larger operand. If the operands are equivalent (e.g. 3 and 3.0), the field does not change. 0, 0.0, and -0.0 are all zero. The maximum of a zero stored value and zero input value is always the stored value. The maximum of any numeric value x and NaN is NaN. - "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. - "values": [ # Values in the array. - # Object with schema name: Value - ], - }, + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -293,11 +300,7 @@

Method Details

"timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. }, "minimum": { # A message that can hold any of the supported value types. # Sets the field to the minimum of its current value and the given value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the input value. If a minimum operation is applied where the field and the input value are of mixed types (that is - one is an integer and one is a double) the field takes on the type of the smaller operand. If the operands are equivalent (e.g. 3 and 3.0), the field does not change. 0, 0.0, and -0.0 are all zero. The minimum of a zero stored value and zero input value is always the stored value. The minimum of any numeric value x and NaN is NaN. - "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. - "values": [ # Values in the array. - # Object with schema name: Value - ], - }, + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -318,7 +321,26 @@

Method Details

}, "removeAllFromArray": { # An array value. # Remove all of the given elements from the array in the field. If the field is not an array, or if the field does not yet exist, it is set to the empty array. Equivalent numbers of the different types (e.g. 3L and 3.0) are considered equal when deciding whether an element should be removed. NaN is equal to NaN, and Null is equal to Null. This will remove all equivalent values if there are duplicates. The corresponding transform_result will be the null value. "values": [ # Values in the array. - # Object with schema name: Value + { # A message that can hold any of the supported value types. + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "booleanValue": True or False, # A boolean value. + "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. + "doubleValue": 3.14, # A double value. + "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + "integerValue": "A String", # An integer value. + "mapValue": { # A map value. # A map value. + "fields": { # The map's fields. The map keys represent field names. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. + "a_key": # Object with schema name: Value + }, + }, + "nullValue": "A String", # A null value. + "referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. + "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. + "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + }, ], }, "setToServerValue": "A String", # Sets the field to the given server value. @@ -329,11 +351,7 @@

Method Details

"createTime": "A String", # Output only. The time at which the document was created. This value increases monotonically when a document is deleted then recreated. It can also be compared to values from other documents and the `read_time` of a query. "fields": { # The document's fields. The map keys represent field names. A simple field name contains only characters `a` to `z`, `A` to `Z`, `0` to `9`, or `_`, and must not start with `0` to `9`. For example, `foo_bar_17`. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. Field paths may be used in other contexts to refer to structured fields defined here. For `map_value`, the field path is represented by the simple or quoted field names of the containing fields, delimited by `.`. For example, the structured field `"foo" : { map_value: { "x&y" : { string_value: "hello" }}}` would be represented by the field path `foo.x&y`. Within a field path, a quoted field name starts and ends with `` ` `` and may contain any character. Some characters, including `` ` ``, must be escaped using a `\`. For example, `` `x&y` `` represents `x&y` and `` `bak\`tik` `` represents `` bak`tik ``. "a_key": { # A message that can hold any of the supported value types. - "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. - "values": [ # Values in the array. - # Object with schema name: Value - ], - }, + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -365,16 +383,31 @@

Method Details

{ # A transformation of a field of the document. "appendMissingElements": { # An array value. # Append the given elements in order if they are not already present in the current field value. If the field is not an array, or if the field does not yet exist, it is first set to the empty array. Equivalent numbers of different types (e.g. 3L and 3.0) are considered equal when checking if a value is missing. NaN is equal to NaN, and Null is equal to Null. If the input contains multiple equivalent values, only the first will be considered. The corresponding transform_result will be the null value. "values": [ # Values in the array. - # Object with schema name: Value + { # A message that can hold any of the supported value types. + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "booleanValue": True or False, # A boolean value. + "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. + "doubleValue": 3.14, # A double value. + "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + "integerValue": "A String", # An integer value. + "mapValue": { # A map value. # A map value. + "fields": { # The map's fields. The map keys represent field names. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. + "a_key": # Object with schema name: Value + }, + }, + "nullValue": "A String", # A null value. + "referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. + "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. + "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + }, ], }, "fieldPath": "A String", # The path of the field. See Document.fields for the field path syntax reference. "increment": { # A message that can hold any of the supported value types. # Adds the given value to the field's current value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the given value. If either of the given value or the current field value are doubles, both values will be interpreted as doubles. Double arithmetic and representation of double values follow IEEE 754 semantics. If there is positive/negative integer overflow, the field is resolved to the largest magnitude positive/negative integer. - "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. - "values": [ # Values in the array. - # Object with schema name: Value - ], - }, + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -394,11 +427,7 @@

Method Details

"timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. }, "maximum": { # A message that can hold any of the supported value types. # Sets the field to the maximum of its current value and the given value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the given value. If a maximum operation is applied where the field and the input value are of mixed types (that is - one is an integer and one is a double) the field takes on the type of the larger operand. If the operands are equivalent (e.g. 3 and 3.0), the field does not change. 0, 0.0, and -0.0 are all zero. The maximum of a zero stored value and zero input value is always the stored value. The maximum of any numeric value x and NaN is NaN. - "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. - "values": [ # Values in the array. - # Object with schema name: Value - ], - }, + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -418,11 +447,7 @@

Method Details

"timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. }, "minimum": { # A message that can hold any of the supported value types. # Sets the field to the minimum of its current value and the given value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the input value. If a minimum operation is applied where the field and the input value are of mixed types (that is - one is an integer and one is a double) the field takes on the type of the smaller operand. If the operands are equivalent (e.g. 3 and 3.0), the field does not change. 0, 0.0, and -0.0 are all zero. The minimum of a zero stored value and zero input value is always the stored value. The minimum of any numeric value x and NaN is NaN. - "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. - "values": [ # Values in the array. - # Object with schema name: Value - ], - }, + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -443,7 +468,26 @@

Method Details

}, "removeAllFromArray": { # An array value. # Remove all of the given elements from the array in the field. If the field is not an array, or if the field does not yet exist, it is set to the empty array. Equivalent numbers of the different types (e.g. 3L and 3.0) are considered equal when deciding whether an element should be removed. NaN is equal to NaN, and Null is equal to Null. This will remove all equivalent values if there are duplicates. The corresponding transform_result will be the null value. "values": [ # Values in the array. - # Object with schema name: Value + { # A message that can hold any of the supported value types. + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "booleanValue": True or False, # A boolean value. + "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. + "doubleValue": 3.14, # A double value. + "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + "integerValue": "A String", # An integer value. + "mapValue": { # A map value. # A map value. + "fields": { # The map's fields. The map keys represent field names. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. + "a_key": # Object with schema name: Value + }, + }, + "nullValue": "A String", # A null value. + "referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. + "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. + "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + }, ], }, "setToServerValue": "A String", # Sets the field to the given server value. @@ -477,11 +521,7 @@

Method Details

{ # The result of applying a write. "transformResults": [ # The results of applying each DocumentTransform.FieldTransform, in the same order. { # A message that can hold any of the supported value types. - "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. - "values": [ # Values in the array. - # Object with schema name: Value - ], - }, + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -569,16 +609,31 @@

Method Details

{ # A transformation of a field of the document. "appendMissingElements": { # An array value. # Append the given elements in order if they are not already present in the current field value. If the field is not an array, or if the field does not yet exist, it is first set to the empty array. Equivalent numbers of different types (e.g. 3L and 3.0) are considered equal when checking if a value is missing. NaN is equal to NaN, and Null is equal to Null. If the input contains multiple equivalent values, only the first will be considered. The corresponding transform_result will be the null value. "values": [ # Values in the array. - # Object with schema name: Value + { # A message that can hold any of the supported value types. + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "booleanValue": True or False, # A boolean value. + "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. + "doubleValue": 3.14, # A double value. + "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + "integerValue": "A String", # An integer value. + "mapValue": { # A map value. # A map value. + "fields": { # The map's fields. The map keys represent field names. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. + "a_key": # Object with schema name: Value + }, + }, + "nullValue": "A String", # A null value. + "referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. + "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. + "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + }, ], }, "fieldPath": "A String", # The path of the field. See Document.fields for the field path syntax reference. "increment": { # A message that can hold any of the supported value types. # Adds the given value to the field's current value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the given value. If either of the given value or the current field value are doubles, both values will be interpreted as doubles. Double arithmetic and representation of double values follow IEEE 754 semantics. If there is positive/negative integer overflow, the field is resolved to the largest magnitude positive/negative integer. - "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. - "values": [ # Values in the array. - # Object with schema name: Value - ], - }, + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -598,11 +653,7 @@

Method Details

"timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. }, "maximum": { # A message that can hold any of the supported value types. # Sets the field to the maximum of its current value and the given value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the given value. If a maximum operation is applied where the field and the input value are of mixed types (that is - one is an integer and one is a double) the field takes on the type of the larger operand. If the operands are equivalent (e.g. 3 and 3.0), the field does not change. 0, 0.0, and -0.0 are all zero. The maximum of a zero stored value and zero input value is always the stored value. The maximum of any numeric value x and NaN is NaN. - "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. - "values": [ # Values in the array. - # Object with schema name: Value - ], - }, + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -622,11 +673,7 @@

Method Details

"timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. }, "minimum": { # A message that can hold any of the supported value types. # Sets the field to the minimum of its current value and the given value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the input value. If a minimum operation is applied where the field and the input value are of mixed types (that is - one is an integer and one is a double) the field takes on the type of the smaller operand. If the operands are equivalent (e.g. 3 and 3.0), the field does not change. 0, 0.0, and -0.0 are all zero. The minimum of a zero stored value and zero input value is always the stored value. The minimum of any numeric value x and NaN is NaN. - "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. - "values": [ # Values in the array. - # Object with schema name: Value - ], - }, + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -647,7 +694,26 @@

Method Details

}, "removeAllFromArray": { # An array value. # Remove all of the given elements from the array in the field. If the field is not an array, or if the field does not yet exist, it is set to the empty array. Equivalent numbers of the different types (e.g. 3L and 3.0) are considered equal when deciding whether an element should be removed. NaN is equal to NaN, and Null is equal to Null. This will remove all equivalent values if there are duplicates. The corresponding transform_result will be the null value. "values": [ # Values in the array. - # Object with schema name: Value + { # A message that can hold any of the supported value types. + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "booleanValue": True or False, # A boolean value. + "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. + "doubleValue": 3.14, # A double value. + "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + "integerValue": "A String", # An integer value. + "mapValue": { # A map value. # A map value. + "fields": { # The map's fields. The map keys represent field names. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. + "a_key": # Object with schema name: Value + }, + }, + "nullValue": "A String", # A null value. + "referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. + "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. + "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + }, ], }, "setToServerValue": "A String", # Sets the field to the given server value. @@ -658,11 +724,7 @@

Method Details

"createTime": "A String", # Output only. The time at which the document was created. This value increases monotonically when a document is deleted then recreated. It can also be compared to values from other documents and the `read_time` of a query. "fields": { # The document's fields. The map keys represent field names. A simple field name contains only characters `a` to `z`, `A` to `Z`, `0` to `9`, or `_`, and must not start with `0` to `9`. For example, `foo_bar_17`. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. Field paths may be used in other contexts to refer to structured fields defined here. For `map_value`, the field path is represented by the simple or quoted field names of the containing fields, delimited by `.`. For example, the structured field `"foo" : { map_value: { "x&y" : { string_value: "hello" }}}` would be represented by the field path `foo.x&y`. Within a field path, a quoted field name starts and ends with `` ` `` and may contain any character. Some characters, including `` ` ``, must be escaped using a `\`. For example, `` `x&y` `` represents `x&y` and `` `bak\`tik` `` represents `` bak`tik ``. "a_key": { # A message that can hold any of the supported value types. - "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. - "values": [ # Values in the array. - # Object with schema name: Value - ], - }, + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -694,16 +756,31 @@

Method Details

{ # A transformation of a field of the document. "appendMissingElements": { # An array value. # Append the given elements in order if they are not already present in the current field value. If the field is not an array, or if the field does not yet exist, it is first set to the empty array. Equivalent numbers of different types (e.g. 3L and 3.0) are considered equal when checking if a value is missing. NaN is equal to NaN, and Null is equal to Null. If the input contains multiple equivalent values, only the first will be considered. The corresponding transform_result will be the null value. "values": [ # Values in the array. - # Object with schema name: Value + { # A message that can hold any of the supported value types. + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "booleanValue": True or False, # A boolean value. + "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. + "doubleValue": 3.14, # A double value. + "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + "integerValue": "A String", # An integer value. + "mapValue": { # A map value. # A map value. + "fields": { # The map's fields. The map keys represent field names. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. + "a_key": # Object with schema name: Value + }, + }, + "nullValue": "A String", # A null value. + "referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. + "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. + "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + }, ], }, "fieldPath": "A String", # The path of the field. See Document.fields for the field path syntax reference. "increment": { # A message that can hold any of the supported value types. # Adds the given value to the field's current value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the given value. If either of the given value or the current field value are doubles, both values will be interpreted as doubles. Double arithmetic and representation of double values follow IEEE 754 semantics. If there is positive/negative integer overflow, the field is resolved to the largest magnitude positive/negative integer. - "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. - "values": [ # Values in the array. - # Object with schema name: Value - ], - }, + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -723,11 +800,7 @@

Method Details

"timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. }, "maximum": { # A message that can hold any of the supported value types. # Sets the field to the maximum of its current value and the given value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the given value. If a maximum operation is applied where the field and the input value are of mixed types (that is - one is an integer and one is a double) the field takes on the type of the larger operand. If the operands are equivalent (e.g. 3 and 3.0), the field does not change. 0, 0.0, and -0.0 are all zero. The maximum of a zero stored value and zero input value is always the stored value. The maximum of any numeric value x and NaN is NaN. - "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. - "values": [ # Values in the array. - # Object with schema name: Value - ], - }, + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -747,11 +820,7 @@

Method Details

"timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. }, "minimum": { # A message that can hold any of the supported value types. # Sets the field to the minimum of its current value and the given value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the input value. If a minimum operation is applied where the field and the input value are of mixed types (that is - one is an integer and one is a double) the field takes on the type of the smaller operand. If the operands are equivalent (e.g. 3 and 3.0), the field does not change. 0, 0.0, and -0.0 are all zero. The minimum of a zero stored value and zero input value is always the stored value. The minimum of any numeric value x and NaN is NaN. - "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. - "values": [ # Values in the array. - # Object with schema name: Value - ], - }, + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -772,7 +841,26 @@

Method Details

}, "removeAllFromArray": { # An array value. # Remove all of the given elements from the array in the field. If the field is not an array, or if the field does not yet exist, it is set to the empty array. Equivalent numbers of the different types (e.g. 3L and 3.0) are considered equal when deciding whether an element should be removed. NaN is equal to NaN, and Null is equal to Null. This will remove all equivalent values if there are duplicates. The corresponding transform_result will be the null value. "values": [ # Values in the array. - # Object with schema name: Value + { # A message that can hold any of the supported value types. + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "booleanValue": True or False, # A boolean value. + "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. + "doubleValue": 3.14, # A double value. + "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + "integerValue": "A String", # An integer value. + "mapValue": { # A map value. # A map value. + "fields": { # The map's fields. The map keys represent field names. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. + "a_key": # Object with schema name: Value + }, + }, + "nullValue": "A String", # A null value. + "referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. + "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. + "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + }, ], }, "setToServerValue": "A String", # Sets the field to the given server value. @@ -796,11 +884,7 @@

Method Details

{ # The result of applying a write. "transformResults": [ # The results of applying each DocumentTransform.FieldTransform, in the same order. { # A message that can hold any of the supported value types. - "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. - "values": [ # Values in the array. - # Object with schema name: Value - ], - }, + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -840,11 +924,7 @@

Method Details

"createTime": "A String", # Output only. The time at which the document was created. This value increases monotonically when a document is deleted then recreated. It can also be compared to values from other documents and the `read_time` of a query. "fields": { # The document's fields. The map keys represent field names. A simple field name contains only characters `a` to `z`, `A` to `Z`, `0` to `9`, or `_`, and must not start with `0` to `9`. For example, `foo_bar_17`. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. Field paths may be used in other contexts to refer to structured fields defined here. For `map_value`, the field path is represented by the simple or quoted field names of the containing fields, delimited by `.`. For example, the structured field `"foo" : { map_value: { "x&y" : { string_value: "hello" }}}` would be represented by the field path `foo.x&y`. Within a field path, a quoted field name starts and ends with `` ` `` and may contain any character. Some characters, including `` ` ``, must be escaped using a `\`. For example, `` `x&y` `` represents `x&y` and `` `bak\`tik` `` represents `` bak`tik ``. "a_key": { # A message that can hold any of the supported value types. - "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. - "values": [ # Values in the array. - # Object with schema name: Value - ], - }, + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -882,11 +962,7 @@

Method Details

"createTime": "A String", # Output only. The time at which the document was created. This value increases monotonically when a document is deleted then recreated. It can also be compared to values from other documents and the `read_time` of a query. "fields": { # The document's fields. The map keys represent field names. A simple field name contains only characters `a` to `z`, `A` to `Z`, `0` to `9`, or `_`, and must not start with `0` to `9`. For example, `foo_bar_17`. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. Field paths may be used in other contexts to refer to structured fields defined here. For `map_value`, the field path is represented by the simple or quoted field names of the containing fields, delimited by `.`. For example, the structured field `"foo" : { map_value: { "x&y" : { string_value: "hello" }}}` would be represented by the field path `foo.x&y`. Within a field path, a quoted field name starts and ends with `` ` `` and may contain any character. Some characters, including `` ` ``, must be escaped using a `\`. For example, `` `x&y` `` represents `x&y` and `` `bak\`tik` `` represents `` bak`tik ``. "a_key": { # A message that can hold any of the supported value types. - "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. - "values": [ # Values in the array. - # Object with schema name: Value - ], - }, + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -952,11 +1028,7 @@

Method Details

"createTime": "A String", # Output only. The time at which the document was created. This value increases monotonically when a document is deleted then recreated. It can also be compared to values from other documents and the `read_time` of a query. "fields": { # The document's fields. The map keys represent field names. A simple field name contains only characters `a` to `z`, `A` to `Z`, `0` to `9`, or `_`, and must not start with `0` to `9`. For example, `foo_bar_17`. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. Field paths may be used in other contexts to refer to structured fields defined here. For `map_value`, the field path is represented by the simple or quoted field names of the containing fields, delimited by `.`. For example, the structured field `"foo" : { map_value: { "x&y" : { string_value: "hello" }}}` would be represented by the field path `foo.x&y`. Within a field path, a quoted field name starts and ends with `` ` `` and may contain any character. Some characters, including `` ` ``, must be escaped using a `\`. For example, `` `x&y` `` represents `x&y` and `` `bak\`tik` `` represents `` bak`tik ``. "a_key": { # A message that can hold any of the supported value types. - "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. - "values": [ # Values in the array. - # Object with schema name: Value - ], - }, + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -1009,11 +1081,7 @@

Method Details

"createTime": "A String", # Output only. The time at which the document was created. This value increases monotonically when a document is deleted then recreated. It can also be compared to values from other documents and the `read_time` of a query. "fields": { # The document's fields. The map keys represent field names. A simple field name contains only characters `a` to `z`, `A` to `Z`, `0` to `9`, or `_`, and must not start with `0` to `9`. For example, `foo_bar_17`. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. Field paths may be used in other contexts to refer to structured fields defined here. For `map_value`, the field path is represented by the simple or quoted field names of the containing fields, delimited by `.`. For example, the structured field `"foo" : { map_value: { "x&y" : { string_value: "hello" }}}` would be represented by the field path `foo.x&y`. Within a field path, a quoted field name starts and ends with `` ` `` and may contain any character. Some characters, including `` ` ``, must be escaped using a `\`. For example, `` `x&y` `` represents `x&y` and `` `bak\`tik` `` represents `` bak`tik ``. "a_key": { # A message that can hold any of the supported value types. - "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. - "values": [ # Values in the array. - # Object with schema name: Value - ], - }, + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -1114,11 +1182,7 @@

Method Details

"createTime": "A String", # Output only. The time at which the document was created. This value increases monotonically when a document is deleted then recreated. It can also be compared to values from other documents and the `read_time` of a query. "fields": { # The document's fields. The map keys represent field names. A simple field name contains only characters `a` to `z`, `A` to `Z`, `0` to `9`, or `_`, and must not start with `0` to `9`. For example, `foo_bar_17`. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. Field paths may be used in other contexts to refer to structured fields defined here. For `map_value`, the field path is represented by the simple or quoted field names of the containing fields, delimited by `.`. For example, the structured field `"foo" : { map_value: { "x&y" : { string_value: "hello" }}}` would be represented by the field path `foo.x&y`. Within a field path, a quoted field name starts and ends with `` ` `` and may contain any character. Some characters, including `` ` ``, must be escaped using a `\`. For example, `` `x&y` `` represents `x&y` and `` `bak\`tik` `` represents `` bak`tik ``. "a_key": { # A message that can hold any of the supported value types. - "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. - "values": [ # Values in the array. - # Object with schema name: Value - ], - }, + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -1198,11 +1262,7 @@

Method Details

"before": True or False, # If the position is just before or just after the given values, relative to the sort order defined by the query. "values": [ # The values that represent a position, in the order they appear in the order by clause of a query. Can contain fewer values than specified in the order by clause. { # A message that can hold any of the supported value types. - "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. - "values": [ # Values in the array. - # Object with schema name: Value - ], - }, + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -1250,11 +1310,7 @@

Method Details

"before": True or False, # If the position is just before or just after the given values, relative to the sort order defined by the query. "values": [ # The values that represent a position, in the order they appear in the order by clause of a query. Can contain fewer values than specified in the order by clause. { # A message that can hold any of the supported value types. - "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. - "values": [ # Values in the array. - # Object with schema name: Value - ], - }, + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -1288,11 +1344,7 @@

Method Details

}, "op": "A String", # The operator to filter by. "value": { # A message that can hold any of the supported value types. # The value to compare to. - "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. - "values": [ # Values in the array. - # Object with schema name: Value - ], - }, + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -1345,11 +1397,7 @@

Method Details

"createTime": "A String", # Output only. The time at which the document was created. This value increases monotonically when a document is deleted then recreated. It can also be compared to values from other documents and the `read_time` of a query. "fields": { # The document's fields. The map keys represent field names. A simple field name contains only characters `a` to `z`, `A` to `Z`, `0` to `9`, or `_`, and must not start with `0` to `9`. For example, `foo_bar_17`. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. Field paths may be used in other contexts to refer to structured fields defined here. For `map_value`, the field path is represented by the simple or quoted field names of the containing fields, delimited by `.`. For example, the structured field `"foo" : { map_value: { "x&y" : { string_value: "hello" }}}` would be represented by the field path `foo.x&y`. Within a field path, a quoted field name starts and ends with `` ` `` and may contain any character. Some characters, including `` ` ``, must be escaped using a `\`. For example, `` `x&y` `` represents `x&y` and `` `bak\`tik` `` represents `` bak`tik ``. "a_key": { # A message that can hold any of the supported value types. - "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. - "values": [ # Values in the array. - # Object with schema name: Value - ], - }, + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -1436,11 +1484,7 @@

Method Details

"before": True or False, # If the position is just before or just after the given values, relative to the sort order defined by the query. "values": [ # The values that represent a position, in the order they appear in the order by clause of a query. Can contain fewer values than specified in the order by clause. { # A message that can hold any of the supported value types. - "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. - "values": [ # Values in the array. - # Object with schema name: Value - ], - }, + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -1488,11 +1532,7 @@

Method Details

"before": True or False, # If the position is just before or just after the given values, relative to the sort order defined by the query. "values": [ # The values that represent a position, in the order they appear in the order by clause of a query. Can contain fewer values than specified in the order by clause. { # A message that can hold any of the supported value types. - "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. - "values": [ # Values in the array. - # Object with schema name: Value - ], - }, + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -1526,11 +1566,7 @@

Method Details

}, "op": "A String", # The operator to filter by. "value": { # A message that can hold any of the supported value types. # The value to compare to. - "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. - "values": [ # Values in the array. - # Object with schema name: Value - ], - }, + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -1575,11 +1611,7 @@

Method Details

"before": True or False, # If the position is just before or just after the given values, relative to the sort order defined by the query. "values": [ # The values that represent a position, in the order they appear in the order by clause of a query. Can contain fewer values than specified in the order by clause. { # A message that can hold any of the supported value types. - "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. - "values": [ # Values in the array. - # Object with schema name: Value - ], - }, + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -1631,11 +1663,7 @@

Method Details

"createTime": "A String", # Output only. The time at which the document was created. This value increases monotonically when a document is deleted then recreated. It can also be compared to values from other documents and the `read_time` of a query. "fields": { # The document's fields. The map keys represent field names. A simple field name contains only characters `a` to `z`, `A` to `Z`, `0` to `9`, or `_`, and must not start with `0` to `9`. For example, `foo_bar_17`. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. Field paths may be used in other contexts to refer to structured fields defined here. For `map_value`, the field path is represented by the simple or quoted field names of the containing fields, delimited by `.`. For example, the structured field `"foo" : { map_value: { "x&y" : { string_value: "hello" }}}` would be represented by the field path `foo.x&y`. Within a field path, a quoted field name starts and ends with `` ` `` and may contain any character. Some characters, including `` ` ``, must be escaped using a `\`. For example, `` `x&y` `` represents `x&y` and `` `bak\`tik` `` represents `` bak`tik ``. "a_key": { # A message that can hold any of the supported value types. - "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. - "values": [ # Values in the array. - # Object with schema name: Value - ], - }, + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -1675,11 +1703,7 @@

Method Details

"createTime": "A String", # Output only. The time at which the document was created. This value increases monotonically when a document is deleted then recreated. It can also be compared to values from other documents and the `read_time` of a query. "fields": { # The document's fields. The map keys represent field names. A simple field name contains only characters `a` to `z`, `A` to `Z`, `0` to `9`, or `_`, and must not start with `0` to `9`. For example, `foo_bar_17`. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. Field paths may be used in other contexts to refer to structured fields defined here. For `map_value`, the field path is represented by the simple or quoted field names of the containing fields, delimited by `.`. For example, the structured field `"foo" : { map_value: { "x&y" : { string_value: "hello" }}}` would be represented by the field path `foo.x&y`. Within a field path, a quoted field name starts and ends with `` ` `` and may contain any character. Some characters, including `` ` ``, must be escaped using a `\`. For example, `` `x&y` `` represents `x&y` and `` `bak\`tik` `` represents `` bak`tik ``. "a_key": { # A message that can hold any of the supported value types. - "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. - "values": [ # Values in the array. - # Object with schema name: Value - ], - }, + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -1753,11 +1777,7 @@

Method Details

"before": True or False, # If the position is just before or just after the given values, relative to the sort order defined by the query. "values": [ # The values that represent a position, in the order they appear in the order by clause of a query. Can contain fewer values than specified in the order by clause. { # A message that can hold any of the supported value types. - "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. - "values": [ # Values in the array. - # Object with schema name: Value - ], - }, + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -1805,11 +1825,7 @@

Method Details

"before": True or False, # If the position is just before or just after the given values, relative to the sort order defined by the query. "values": [ # The values that represent a position, in the order they appear in the order by clause of a query. Can contain fewer values than specified in the order by clause. { # A message that can hold any of the supported value types. - "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. - "values": [ # Values in the array. - # Object with schema name: Value - ], - }, + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -1843,11 +1859,7 @@

Method Details

}, "op": "A String", # The operator to filter by. "value": { # A message that can hold any of the supported value types. # The value to compare to. - "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. - "values": [ # Values in the array. - # Object with schema name: Value - ], - }, + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -1891,11 +1903,7 @@

Method Details

"createTime": "A String", # Output only. The time at which the document was created. This value increases monotonically when a document is deleted then recreated. It can also be compared to values from other documents and the `read_time` of a query. "fields": { # The document's fields. The map keys represent field names. A simple field name contains only characters `a` to `z`, `A` to `Z`, `0` to `9`, or `_`, and must not start with `0` to `9`. For example, `foo_bar_17`. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. Field paths may be used in other contexts to refer to structured fields defined here. For `map_value`, the field path is represented by the simple or quoted field names of the containing fields, delimited by `.`. For example, the structured field `"foo" : { map_value: { "x&y" : { string_value: "hello" }}}` would be represented by the field path `foo.x&y`. Within a field path, a quoted field name starts and ends with `` ` `` and may contain any character. Some characters, including `` ` ``, must be escaped using a `\`. For example, `` `x&y` `` represents `x&y` and `` `bak\`tik` `` represents `` bak`tik ``. "a_key": { # A message that can hold any of the supported value types. - "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. - "values": [ # Values in the array. - # Object with schema name: Value - ], - }, + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -1953,16 +1961,31 @@

Method Details

{ # A transformation of a field of the document. "appendMissingElements": { # An array value. # Append the given elements in order if they are not already present in the current field value. If the field is not an array, or if the field does not yet exist, it is first set to the empty array. Equivalent numbers of different types (e.g. 3L and 3.0) are considered equal when checking if a value is missing. NaN is equal to NaN, and Null is equal to Null. If the input contains multiple equivalent values, only the first will be considered. The corresponding transform_result will be the null value. "values": [ # Values in the array. - # Object with schema name: Value + { # A message that can hold any of the supported value types. + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "booleanValue": True or False, # A boolean value. + "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. + "doubleValue": 3.14, # A double value. + "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + "integerValue": "A String", # An integer value. + "mapValue": { # A map value. # A map value. + "fields": { # The map's fields. The map keys represent field names. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. + "a_key": # Object with schema name: Value + }, + }, + "nullValue": "A String", # A null value. + "referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. + "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. + "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + }, ], }, "fieldPath": "A String", # The path of the field. See Document.fields for the field path syntax reference. "increment": { # A message that can hold any of the supported value types. # Adds the given value to the field's current value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the given value. If either of the given value or the current field value are doubles, both values will be interpreted as doubles. Double arithmetic and representation of double values follow IEEE 754 semantics. If there is positive/negative integer overflow, the field is resolved to the largest magnitude positive/negative integer. - "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. - "values": [ # Values in the array. - # Object with schema name: Value - ], - }, + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -1982,11 +2005,7 @@

Method Details

"timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. }, "maximum": { # A message that can hold any of the supported value types. # Sets the field to the maximum of its current value and the given value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the given value. If a maximum operation is applied where the field and the input value are of mixed types (that is - one is an integer and one is a double) the field takes on the type of the larger operand. If the operands are equivalent (e.g. 3 and 3.0), the field does not change. 0, 0.0, and -0.0 are all zero. The maximum of a zero stored value and zero input value is always the stored value. The maximum of any numeric value x and NaN is NaN. - "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. - "values": [ # Values in the array. - # Object with schema name: Value - ], - }, + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -2006,11 +2025,7 @@

Method Details

"timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. }, "minimum": { # A message that can hold any of the supported value types. # Sets the field to the minimum of its current value and the given value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the input value. If a minimum operation is applied where the field and the input value are of mixed types (that is - one is an integer and one is a double) the field takes on the type of the smaller operand. If the operands are equivalent (e.g. 3 and 3.0), the field does not change. 0, 0.0, and -0.0 are all zero. The minimum of a zero stored value and zero input value is always the stored value. The minimum of any numeric value x and NaN is NaN. - "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. - "values": [ # Values in the array. - # Object with schema name: Value - ], - }, + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -2031,7 +2046,26 @@

Method Details

}, "removeAllFromArray": { # An array value. # Remove all of the given elements from the array in the field. If the field is not an array, or if the field does not yet exist, it is set to the empty array. Equivalent numbers of the different types (e.g. 3L and 3.0) are considered equal when deciding whether an element should be removed. NaN is equal to NaN, and Null is equal to Null. This will remove all equivalent values if there are duplicates. The corresponding transform_result will be the null value. "values": [ # Values in the array. - # Object with schema name: Value + { # A message that can hold any of the supported value types. + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "booleanValue": True or False, # A boolean value. + "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. + "doubleValue": 3.14, # A double value. + "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + "integerValue": "A String", # An integer value. + "mapValue": { # A map value. # A map value. + "fields": { # The map's fields. The map keys represent field names. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. + "a_key": # Object with schema name: Value + }, + }, + "nullValue": "A String", # A null value. + "referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. + "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. + "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + }, ], }, "setToServerValue": "A String", # Sets the field to the given server value. @@ -2042,11 +2076,7 @@

Method Details

"createTime": "A String", # Output only. The time at which the document was created. This value increases monotonically when a document is deleted then recreated. It can also be compared to values from other documents and the `read_time` of a query. "fields": { # The document's fields. The map keys represent field names. A simple field name contains only characters `a` to `z`, `A` to `Z`, `0` to `9`, or `_`, and must not start with `0` to `9`. For example, `foo_bar_17`. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. Field paths may be used in other contexts to refer to structured fields defined here. For `map_value`, the field path is represented by the simple or quoted field names of the containing fields, delimited by `.`. For example, the structured field `"foo" : { map_value: { "x&y" : { string_value: "hello" }}}` would be represented by the field path `foo.x&y`. Within a field path, a quoted field name starts and ends with `` ` `` and may contain any character. Some characters, including `` ` ``, must be escaped using a `\`. For example, `` `x&y` `` represents `x&y` and `` `bak\`tik` `` represents `` bak`tik ``. "a_key": { # A message that can hold any of the supported value types. - "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. - "values": [ # Values in the array. - # Object with schema name: Value - ], - }, + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -2078,16 +2108,31 @@

Method Details

{ # A transformation of a field of the document. "appendMissingElements": { # An array value. # Append the given elements in order if they are not already present in the current field value. If the field is not an array, or if the field does not yet exist, it is first set to the empty array. Equivalent numbers of different types (e.g. 3L and 3.0) are considered equal when checking if a value is missing. NaN is equal to NaN, and Null is equal to Null. If the input contains multiple equivalent values, only the first will be considered. The corresponding transform_result will be the null value. "values": [ # Values in the array. - # Object with schema name: Value + { # A message that can hold any of the supported value types. + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "booleanValue": True or False, # A boolean value. + "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. + "doubleValue": 3.14, # A double value. + "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + "integerValue": "A String", # An integer value. + "mapValue": { # A map value. # A map value. + "fields": { # The map's fields. The map keys represent field names. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. + "a_key": # Object with schema name: Value + }, + }, + "nullValue": "A String", # A null value. + "referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. + "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. + "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + }, ], }, "fieldPath": "A String", # The path of the field. See Document.fields for the field path syntax reference. "increment": { # A message that can hold any of the supported value types. # Adds the given value to the field's current value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the given value. If either of the given value or the current field value are doubles, both values will be interpreted as doubles. Double arithmetic and representation of double values follow IEEE 754 semantics. If there is positive/negative integer overflow, the field is resolved to the largest magnitude positive/negative integer. - "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. - "values": [ # Values in the array. - # Object with schema name: Value - ], - }, + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -2107,11 +2152,7 @@

Method Details

"timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. }, "maximum": { # A message that can hold any of the supported value types. # Sets the field to the maximum of its current value and the given value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the given value. If a maximum operation is applied where the field and the input value are of mixed types (that is - one is an integer and one is a double) the field takes on the type of the larger operand. If the operands are equivalent (e.g. 3 and 3.0), the field does not change. 0, 0.0, and -0.0 are all zero. The maximum of a zero stored value and zero input value is always the stored value. The maximum of any numeric value x and NaN is NaN. - "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. - "values": [ # Values in the array. - # Object with schema name: Value - ], - }, + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -2131,11 +2172,7 @@

Method Details

"timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. }, "minimum": { # A message that can hold any of the supported value types. # Sets the field to the minimum of its current value and the given value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the input value. If a minimum operation is applied where the field and the input value are of mixed types (that is - one is an integer and one is a double) the field takes on the type of the smaller operand. If the operands are equivalent (e.g. 3 and 3.0), the field does not change. 0, 0.0, and -0.0 are all zero. The minimum of a zero stored value and zero input value is always the stored value. The minimum of any numeric value x and NaN is NaN. - "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. - "values": [ # Values in the array. - # Object with schema name: Value - ], - }, + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. @@ -2156,7 +2193,26 @@

Method Details

}, "removeAllFromArray": { # An array value. # Remove all of the given elements from the array in the field. If the field is not an array, or if the field does not yet exist, it is set to the empty array. Equivalent numbers of the different types (e.g. 3L and 3.0) are considered equal when deciding whether an element should be removed. NaN is equal to NaN, and Null is equal to Null. This will remove all equivalent values if there are duplicates. The corresponding transform_result will be the null value. "values": [ # Values in the array. - # Object with schema name: Value + { # A message that can hold any of the supported value types. + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. + "booleanValue": True or False, # A boolean value. + "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. + "doubleValue": 3.14, # A double value. + "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + "integerValue": "A String", # An integer value. + "mapValue": { # A map value. # A map value. + "fields": { # The map's fields. The map keys represent field names. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. + "a_key": # Object with schema name: Value + }, + }, + "nullValue": "A String", # A null value. + "referenceValue": "A String", # A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. + "stringValue": "A String", # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. + "timestampValue": "A String", # A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down. + }, ], }, "setToServerValue": "A String", # Sets the field to the given server value. @@ -2182,11 +2238,7 @@

Method Details

{ # The result of applying a write. "transformResults": [ # The results of applying each DocumentTransform.FieldTransform, in the same order. { # A message that can hold any of the supported value types. - "arrayValue": { # An array value. # An array value. Cannot directly contain another array value, though can contain an map which contains another array. - "values": [ # Values in the array. - # Object with schema name: Value - ], - }, + "arrayValue": # Object with schema name: ArrayValue # An array value. Cannot directly contain another array value, though can contain an map which contains another array. "booleanValue": True or False, # A boolean value. "bytesValue": "A String", # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. "doubleValue": 3.14, # A double value. diff --git a/docs/dyn/logging_v2.billingAccounts.sinks.html b/docs/dyn/logging_v2.billingAccounts.sinks.html index a15f18e1c22..9acdbfb6353 100644 --- a/docs/dyn/logging_v2.billingAccounts.sinks.html +++ b/docs/dyn/logging_v2.billingAccounts.sinks.html @@ -137,7 +137,7 @@

Method Details

"name": "A String", # Required. The client-assigned sink identifier, unique within the project.For example: "my-syslog-errors-to-pubsub". Sink identifiers are limited to 100 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods. First character has to be alphanumeric. "outputVersionFormat": "A String", # Deprecated. This field is unused. "updateTime": "A String", # Output only. The last update timestamp of the sink.This field may not be present for older sinks. - "writerIdentity": "A String", # Output only. An IAM identity—a service account or group—under which Cloud Logging writes the exported log entries to the sink's destination. This field is set by sinks.create and sinks.update based on the value of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting Access for a Resource (https://cloud.google.com/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.Sinks that have a destination that is a log bucket in the same project as the sink do not have a writer_identity and no additional permissions are required. + "writerIdentity": "A String", # Output only. An IAM identity—a service account or group—under which Cloud Logging writes the exported log entries to the sink's destination. This field is either set by specifying custom_writer_identity or set automatically by sinks.create and sinks.update based on the value of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting Access for a Resource (https://cloud.google.com/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.Sinks that have a destination that is a log bucket in the same project as the sink cannot have a writer_identity and no additional permissions are required. } uniqueWriterIdentity: boolean, Optional. Determines the kind of IAM identity returned as writer_identity in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value returned as writer_identity is the same group or service account used by Cloud Logging before the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself.If this field is set to true, or if the sink is owned by a non-project resource such as an organization, then the value of writer_identity will be a unique service account used only for exports from the new sink. For more information, see writer_identity in LogSink. @@ -173,7 +173,7 @@

Method Details

"name": "A String", # Required. The client-assigned sink identifier, unique within the project.For example: "my-syslog-errors-to-pubsub". Sink identifiers are limited to 100 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods. First character has to be alphanumeric. "outputVersionFormat": "A String", # Deprecated. This field is unused. "updateTime": "A String", # Output only. The last update timestamp of the sink.This field may not be present for older sinks. - "writerIdentity": "A String", # Output only. An IAM identity—a service account or group—under which Cloud Logging writes the exported log entries to the sink's destination. This field is set by sinks.create and sinks.update based on the value of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting Access for a Resource (https://cloud.google.com/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.Sinks that have a destination that is a log bucket in the same project as the sink do not have a writer_identity and no additional permissions are required. + "writerIdentity": "A String", # Output only. An IAM identity—a service account or group—under which Cloud Logging writes the exported log entries to the sink's destination. This field is either set by specifying custom_writer_identity or set automatically by sinks.create and sinks.update based on the value of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting Access for a Resource (https://cloud.google.com/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.Sinks that have a destination that is a log bucket in the same project as the sink cannot have a writer_identity and no additional permissions are required. }
@@ -233,7 +233,7 @@

Method Details

"name": "A String", # Required. The client-assigned sink identifier, unique within the project.For example: "my-syslog-errors-to-pubsub". Sink identifiers are limited to 100 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods. First character has to be alphanumeric. "outputVersionFormat": "A String", # Deprecated. This field is unused. "updateTime": "A String", # Output only. The last update timestamp of the sink.This field may not be present for older sinks. - "writerIdentity": "A String", # Output only. An IAM identity—a service account or group—under which Cloud Logging writes the exported log entries to the sink's destination. This field is set by sinks.create and sinks.update based on the value of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting Access for a Resource (https://cloud.google.com/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.Sinks that have a destination that is a log bucket in the same project as the sink do not have a writer_identity and no additional permissions are required. + "writerIdentity": "A String", # Output only. An IAM identity—a service account or group—under which Cloud Logging writes the exported log entries to the sink's destination. This field is either set by specifying custom_writer_identity or set automatically by sinks.create and sinks.update based on the value of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting Access for a Resource (https://cloud.google.com/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.Sinks that have a destination that is a log bucket in the same project as the sink cannot have a writer_identity and no additional permissions are required. }
@@ -280,7 +280,7 @@

Method Details

"name": "A String", # Required. The client-assigned sink identifier, unique within the project.For example: "my-syslog-errors-to-pubsub". Sink identifiers are limited to 100 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods. First character has to be alphanumeric. "outputVersionFormat": "A String", # Deprecated. This field is unused. "updateTime": "A String", # Output only. The last update timestamp of the sink.This field may not be present for older sinks. - "writerIdentity": "A String", # Output only. An IAM identity—a service account or group—under which Cloud Logging writes the exported log entries to the sink's destination. This field is set by sinks.create and sinks.update based on the value of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting Access for a Resource (https://cloud.google.com/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.Sinks that have a destination that is a log bucket in the same project as the sink do not have a writer_identity and no additional permissions are required. + "writerIdentity": "A String", # Output only. An IAM identity—a service account or group—under which Cloud Logging writes the exported log entries to the sink's destination. This field is either set by specifying custom_writer_identity or set automatically by sinks.create and sinks.update based on the value of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting Access for a Resource (https://cloud.google.com/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.Sinks that have a destination that is a log bucket in the same project as the sink cannot have a writer_identity and no additional permissions are required. }, ], }
@@ -333,7 +333,7 @@

Method Details

"name": "A String", # Required. The client-assigned sink identifier, unique within the project.For example: "my-syslog-errors-to-pubsub". Sink identifiers are limited to 100 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods. First character has to be alphanumeric. "outputVersionFormat": "A String", # Deprecated. This field is unused. "updateTime": "A String", # Output only. The last update timestamp of the sink.This field may not be present for older sinks. - "writerIdentity": "A String", # Output only. An IAM identity—a service account or group—under which Cloud Logging writes the exported log entries to the sink's destination. This field is set by sinks.create and sinks.update based on the value of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting Access for a Resource (https://cloud.google.com/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.Sinks that have a destination that is a log bucket in the same project as the sink do not have a writer_identity and no additional permissions are required. + "writerIdentity": "A String", # Output only. An IAM identity—a service account or group—under which Cloud Logging writes the exported log entries to the sink's destination. This field is either set by specifying custom_writer_identity or set automatically by sinks.create and sinks.update based on the value of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting Access for a Resource (https://cloud.google.com/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.Sinks that have a destination that is a log bucket in the same project as the sink cannot have a writer_identity and no additional permissions are required. } uniqueWriterIdentity: boolean, Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field: If the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity. If the old value is false and the new value is true, then writer_identity is changed to a unique service account. It is an error if the old value is true and the new value is set to false or defaulted to false. @@ -370,7 +370,7 @@

Method Details

"name": "A String", # Required. The client-assigned sink identifier, unique within the project.For example: "my-syslog-errors-to-pubsub". Sink identifiers are limited to 100 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods. First character has to be alphanumeric. "outputVersionFormat": "A String", # Deprecated. This field is unused. "updateTime": "A String", # Output only. The last update timestamp of the sink.This field may not be present for older sinks. - "writerIdentity": "A String", # Output only. An IAM identity—a service account or group—under which Cloud Logging writes the exported log entries to the sink's destination. This field is set by sinks.create and sinks.update based on the value of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting Access for a Resource (https://cloud.google.com/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.Sinks that have a destination that is a log bucket in the same project as the sink do not have a writer_identity and no additional permissions are required. + "writerIdentity": "A String", # Output only. An IAM identity—a service account or group—under which Cloud Logging writes the exported log entries to the sink's destination. This field is either set by specifying custom_writer_identity or set automatically by sinks.create and sinks.update based on the value of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting Access for a Resource (https://cloud.google.com/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.Sinks that have a destination that is a log bucket in the same project as the sink cannot have a writer_identity and no additional permissions are required. }
@@ -407,7 +407,7 @@

Method Details

"name": "A String", # Required. The client-assigned sink identifier, unique within the project.For example: "my-syslog-errors-to-pubsub". Sink identifiers are limited to 100 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods. First character has to be alphanumeric. "outputVersionFormat": "A String", # Deprecated. This field is unused. "updateTime": "A String", # Output only. The last update timestamp of the sink.This field may not be present for older sinks. - "writerIdentity": "A String", # Output only. An IAM identity—a service account or group—under which Cloud Logging writes the exported log entries to the sink's destination. This field is set by sinks.create and sinks.update based on the value of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting Access for a Resource (https://cloud.google.com/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.Sinks that have a destination that is a log bucket in the same project as the sink do not have a writer_identity and no additional permissions are required. + "writerIdentity": "A String", # Output only. An IAM identity—a service account or group—under which Cloud Logging writes the exported log entries to the sink's destination. This field is either set by specifying custom_writer_identity or set automatically by sinks.create and sinks.update based on the value of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting Access for a Resource (https://cloud.google.com/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.Sinks that have a destination that is a log bucket in the same project as the sink cannot have a writer_identity and no additional permissions are required. } uniqueWriterIdentity: boolean, Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field: If the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity. If the old value is false and the new value is true, then writer_identity is changed to a unique service account. It is an error if the old value is true and the new value is set to false or defaulted to false. @@ -444,7 +444,7 @@

Method Details

"name": "A String", # Required. The client-assigned sink identifier, unique within the project.For example: "my-syslog-errors-to-pubsub". Sink identifiers are limited to 100 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods. First character has to be alphanumeric. "outputVersionFormat": "A String", # Deprecated. This field is unused. "updateTime": "A String", # Output only. The last update timestamp of the sink.This field may not be present for older sinks. - "writerIdentity": "A String", # Output only. An IAM identity—a service account or group—under which Cloud Logging writes the exported log entries to the sink's destination. This field is set by sinks.create and sinks.update based on the value of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting Access for a Resource (https://cloud.google.com/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.Sinks that have a destination that is a log bucket in the same project as the sink do not have a writer_identity and no additional permissions are required. + "writerIdentity": "A String", # Output only. An IAM identity—a service account or group—under which Cloud Logging writes the exported log entries to the sink's destination. This field is either set by specifying custom_writer_identity or set automatically by sinks.create and sinks.update based on the value of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting Access for a Resource (https://cloud.google.com/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.Sinks that have a destination that is a log bucket in the same project as the sink cannot have a writer_identity and no additional permissions are required. }
diff --git a/docs/dyn/logging_v2.entries.html b/docs/dyn/logging_v2.entries.html index 4fe314cac09..60f59c19d2f 100644 --- a/docs/dyn/logging_v2.entries.html +++ b/docs/dyn/logging_v2.entries.html @@ -228,7 +228,7 @@

Method Details

"function": "A String", # Optional. Human-readable name of the function or method being invoked, with optional context such as the class or package name. This information may be used in contexts such as the logs viewer, where a file and line number are less meaningful. The format can vary by language. For example: qual.if.ied.Class.method (Java), dir/package.func (Go), function (Python). "line": "A String", # Optional. Line within the source file. 1-based; 0 indicates no line number available. }, - "spanId": "A String", # Optional. The span ID within the trace associated with the log entry.For Trace spans, this is the same format that the Trace API v2 uses: a 16-character hexadecimal encoding of an 8-byte array, such as 000000000000004a. + "spanId": "A String", # Optional. The ID of the Cloud Trace (https://cloud.google.com/trace) span associated with the current operation in which the log is being written. For example, if a span has the REST resource name of "projects/some-project/traces/some-trace/spans/some-span-id", then the span_id field is "some-span-id".A Span (https://cloud.google.com/trace/docs/reference/v2/rest/v2/projects.traces/batchWrite#Span) represents a single operation within a trace. Whereas a trace may involve multiple different microservices running on multiple different machines, a span generally corresponds to a single logical operation being performed in a single instance of a microservice on one specific machine. Spans are the nodes within the tree that is a trace.Applications that are instrumented for tracing (https://cloud.google.com/trace/docs/setup) will generally assign a new, unique span ID on each incoming request. It is also common to create and record additional spans corresponding to internal processing elements as well as issuing requests to dependencies.The span ID is expected to be a 16-character, hexadecimal encoding of an 8-byte array and should not be zero. It should be unique within the trace and should, ideally, be generated in a manner that is uniformly random.Example values: 000000000000004a 7a2190356c3fc94b 0000f00300090021 d39223e101960076 "split": { # Additional information used to correlate multiple log entries. Used when a single LogEntry would exceed the Google Cloud Logging size limit and is split across multiple log entries. # Optional. Information indicating this LogEntry is part of a sequence of multiple log entries split from a single LogEntry. "index": 42, # The index of this LogEntry in the sequence of split log entries. Log entries are given |index| values 0, 1, ..., n-1 for a sequence of n log entries. "totalSplits": 42, # The total number of log entries that the original LogEntry was split into. @@ -236,7 +236,7 @@

Method Details

}, "textPayload": "A String", # The log entry payload, represented as a Unicode string (UTF-8). "timestamp": "A String", # Optional. The time the event described by the log entry occurred. This time is used to compute the log entry's age and to enforce the logs retention period. If this field is omitted in a new log entry, then Logging assigns it the current time. Timestamps have nanosecond accuracy, but trailing zeros in the fractional seconds might be omitted when the timestamp is displayed.Incoming log entries must have timestamps that don't exceed the logs retention period (https://cloud.google.com/logging/quotas#logs_retention_periods) in the past, and that don't exceed 24 hours in the future. Log entries outside those time boundaries aren't ingested by Logging. - "trace": "A String", # Optional. Resource name of the trace associated with the log entry, if any. If it contains a relative resource name, the name is assumed to be relative to //tracing.googleapis.com. Example: projects/my-projectid/traces/06796866738c859f2f19b7cfb3214824 + "trace": "A String", # Optional. The REST resource name of the trace being written to Cloud Trace (https://cloud.google.com/trace) in association with this log entry. For example, if your trace data is stored in the Cloud project "my-trace-project" and if the service that is creating the log entry receives a trace header that includes the trace ID "12345", then the service should use "projects/my-tracing-project/traces/12345".The trace field provides the link between logs and traces. By using this field, you can navigate from a log entry to a trace. "traceSampled": True or False, # Optional. The sampling decision of the trace associated with the log entry.True means that the trace resource name in the trace field was sampled for storage in a trace backend. False means that the trace was not sampled for storage when this log entry was written, or the sampling decision was unknown at the time. A non-sampled trace value is still useful as a request correlation identifier. The default is False. }, ], @@ -340,7 +340,7 @@

Method Details

"function": "A String", # Optional. Human-readable name of the function or method being invoked, with optional context such as the class or package name. This information may be used in contexts such as the logs viewer, where a file and line number are less meaningful. The format can vary by language. For example: qual.if.ied.Class.method (Java), dir/package.func (Go), function (Python). "line": "A String", # Optional. Line within the source file. 1-based; 0 indicates no line number available. }, - "spanId": "A String", # Optional. The span ID within the trace associated with the log entry.For Trace spans, this is the same format that the Trace API v2 uses: a 16-character hexadecimal encoding of an 8-byte array, such as 000000000000004a. + "spanId": "A String", # Optional. The ID of the Cloud Trace (https://cloud.google.com/trace) span associated with the current operation in which the log is being written. For example, if a span has the REST resource name of "projects/some-project/traces/some-trace/spans/some-span-id", then the span_id field is "some-span-id".A Span (https://cloud.google.com/trace/docs/reference/v2/rest/v2/projects.traces/batchWrite#Span) represents a single operation within a trace. Whereas a trace may involve multiple different microservices running on multiple different machines, a span generally corresponds to a single logical operation being performed in a single instance of a microservice on one specific machine. Spans are the nodes within the tree that is a trace.Applications that are instrumented for tracing (https://cloud.google.com/trace/docs/setup) will generally assign a new, unique span ID on each incoming request. It is also common to create and record additional spans corresponding to internal processing elements as well as issuing requests to dependencies.The span ID is expected to be a 16-character, hexadecimal encoding of an 8-byte array and should not be zero. It should be unique within the trace and should, ideally, be generated in a manner that is uniformly random.Example values: 000000000000004a 7a2190356c3fc94b 0000f00300090021 d39223e101960076 "split": { # Additional information used to correlate multiple log entries. Used when a single LogEntry would exceed the Google Cloud Logging size limit and is split across multiple log entries. # Optional. Information indicating this LogEntry is part of a sequence of multiple log entries split from a single LogEntry. "index": 42, # The index of this LogEntry in the sequence of split log entries. Log entries are given |index| values 0, 1, ..., n-1 for a sequence of n log entries. "totalSplits": 42, # The total number of log entries that the original LogEntry was split into. @@ -348,7 +348,7 @@

Method Details

}, "textPayload": "A String", # The log entry payload, represented as a Unicode string (UTF-8). "timestamp": "A String", # Optional. The time the event described by the log entry occurred. This time is used to compute the log entry's age and to enforce the logs retention period. If this field is omitted in a new log entry, then Logging assigns it the current time. Timestamps have nanosecond accuracy, but trailing zeros in the fractional seconds might be omitted when the timestamp is displayed.Incoming log entries must have timestamps that don't exceed the logs retention period (https://cloud.google.com/logging/quotas#logs_retention_periods) in the past, and that don't exceed 24 hours in the future. Log entries outside those time boundaries aren't ingested by Logging. - "trace": "A String", # Optional. Resource name of the trace associated with the log entry, if any. If it contains a relative resource name, the name is assumed to be relative to //tracing.googleapis.com. Example: projects/my-projectid/traces/06796866738c859f2f19b7cfb3214824 + "trace": "A String", # Optional. The REST resource name of the trace being written to Cloud Trace (https://cloud.google.com/trace) in association with this log entry. For example, if your trace data is stored in the Cloud project "my-trace-project" and if the service that is creating the log entry receives a trace header that includes the trace ID "12345", then the service should use "projects/my-tracing-project/traces/12345".The trace field provides the link between logs and traces. By using this field, you can navigate from a log entry to a trace. "traceSampled": True or False, # Optional. The sampling decision of the trace associated with the log entry.True means that the trace resource name in the trace field was sampled for storage in a trace backend. False means that the trace was not sampled for storage when this log entry was written, or the sampling decision was unknown at the time. A non-sampled trace value is still useful as a request correlation identifier. The default is False. }, ], @@ -428,7 +428,7 @@

Method Details

"function": "A String", # Optional. Human-readable name of the function or method being invoked, with optional context such as the class or package name. This information may be used in contexts such as the logs viewer, where a file and line number are less meaningful. The format can vary by language. For example: qual.if.ied.Class.method (Java), dir/package.func (Go), function (Python). "line": "A String", # Optional. Line within the source file. 1-based; 0 indicates no line number available. }, - "spanId": "A String", # Optional. The span ID within the trace associated with the log entry.For Trace spans, this is the same format that the Trace API v2 uses: a 16-character hexadecimal encoding of an 8-byte array, such as 000000000000004a. + "spanId": "A String", # Optional. The ID of the Cloud Trace (https://cloud.google.com/trace) span associated with the current operation in which the log is being written. For example, if a span has the REST resource name of "projects/some-project/traces/some-trace/spans/some-span-id", then the span_id field is "some-span-id".A Span (https://cloud.google.com/trace/docs/reference/v2/rest/v2/projects.traces/batchWrite#Span) represents a single operation within a trace. Whereas a trace may involve multiple different microservices running on multiple different machines, a span generally corresponds to a single logical operation being performed in a single instance of a microservice on one specific machine. Spans are the nodes within the tree that is a trace.Applications that are instrumented for tracing (https://cloud.google.com/trace/docs/setup) will generally assign a new, unique span ID on each incoming request. It is also common to create and record additional spans corresponding to internal processing elements as well as issuing requests to dependencies.The span ID is expected to be a 16-character, hexadecimal encoding of an 8-byte array and should not be zero. It should be unique within the trace and should, ideally, be generated in a manner that is uniformly random.Example values: 000000000000004a 7a2190356c3fc94b 0000f00300090021 d39223e101960076 "split": { # Additional information used to correlate multiple log entries. Used when a single LogEntry would exceed the Google Cloud Logging size limit and is split across multiple log entries. # Optional. Information indicating this LogEntry is part of a sequence of multiple log entries split from a single LogEntry. "index": 42, # The index of this LogEntry in the sequence of split log entries. Log entries are given |index| values 0, 1, ..., n-1 for a sequence of n log entries. "totalSplits": 42, # The total number of log entries that the original LogEntry was split into. @@ -436,7 +436,7 @@

Method Details

}, "textPayload": "A String", # The log entry payload, represented as a Unicode string (UTF-8). "timestamp": "A String", # Optional. The time the event described by the log entry occurred. This time is used to compute the log entry's age and to enforce the logs retention period. If this field is omitted in a new log entry, then Logging assigns it the current time. Timestamps have nanosecond accuracy, but trailing zeros in the fractional seconds might be omitted when the timestamp is displayed.Incoming log entries must have timestamps that don't exceed the logs retention period (https://cloud.google.com/logging/quotas#logs_retention_periods) in the past, and that don't exceed 24 hours in the future. Log entries outside those time boundaries aren't ingested by Logging. - "trace": "A String", # Optional. Resource name of the trace associated with the log entry, if any. If it contains a relative resource name, the name is assumed to be relative to //tracing.googleapis.com. Example: projects/my-projectid/traces/06796866738c859f2f19b7cfb3214824 + "trace": "A String", # Optional. The REST resource name of the trace being written to Cloud Trace (https://cloud.google.com/trace) in association with this log entry. For example, if your trace data is stored in the Cloud project "my-trace-project" and if the service that is creating the log entry receives a trace header that includes the trace ID "12345", then the service should use "projects/my-tracing-project/traces/12345".The trace field provides the link between logs and traces. By using this field, you can navigate from a log entry to a trace. "traceSampled": True or False, # Optional. The sampling decision of the trace associated with the log entry.True means that the trace resource name in the trace field was sampled for storage in a trace backend. False means that the trace was not sampled for storage when this log entry was written, or the sampling decision was unknown at the time. A non-sampled trace value is still useful as a request correlation identifier. The default is False. }, ], diff --git a/docs/dyn/logging_v2.folders.sinks.html b/docs/dyn/logging_v2.folders.sinks.html index 5ea5c4ec235..52f22d60fcb 100644 --- a/docs/dyn/logging_v2.folders.sinks.html +++ b/docs/dyn/logging_v2.folders.sinks.html @@ -137,7 +137,7 @@

Method Details

"name": "A String", # Required. The client-assigned sink identifier, unique within the project.For example: "my-syslog-errors-to-pubsub". Sink identifiers are limited to 100 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods. First character has to be alphanumeric. "outputVersionFormat": "A String", # Deprecated. This field is unused. "updateTime": "A String", # Output only. The last update timestamp of the sink.This field may not be present for older sinks. - "writerIdentity": "A String", # Output only. An IAM identity—a service account or group—under which Cloud Logging writes the exported log entries to the sink's destination. This field is set by sinks.create and sinks.update based on the value of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting Access for a Resource (https://cloud.google.com/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.Sinks that have a destination that is a log bucket in the same project as the sink do not have a writer_identity and no additional permissions are required. + "writerIdentity": "A String", # Output only. An IAM identity—a service account or group—under which Cloud Logging writes the exported log entries to the sink's destination. This field is either set by specifying custom_writer_identity or set automatically by sinks.create and sinks.update based on the value of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting Access for a Resource (https://cloud.google.com/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.Sinks that have a destination that is a log bucket in the same project as the sink cannot have a writer_identity and no additional permissions are required. } uniqueWriterIdentity: boolean, Optional. Determines the kind of IAM identity returned as writer_identity in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value returned as writer_identity is the same group or service account used by Cloud Logging before the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself.If this field is set to true, or if the sink is owned by a non-project resource such as an organization, then the value of writer_identity will be a unique service account used only for exports from the new sink. For more information, see writer_identity in LogSink. @@ -173,7 +173,7 @@

Method Details

"name": "A String", # Required. The client-assigned sink identifier, unique within the project.For example: "my-syslog-errors-to-pubsub". Sink identifiers are limited to 100 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods. First character has to be alphanumeric. "outputVersionFormat": "A String", # Deprecated. This field is unused. "updateTime": "A String", # Output only. The last update timestamp of the sink.This field may not be present for older sinks. - "writerIdentity": "A String", # Output only. An IAM identity—a service account or group—under which Cloud Logging writes the exported log entries to the sink's destination. This field is set by sinks.create and sinks.update based on the value of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting Access for a Resource (https://cloud.google.com/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.Sinks that have a destination that is a log bucket in the same project as the sink do not have a writer_identity and no additional permissions are required. + "writerIdentity": "A String", # Output only. An IAM identity—a service account or group—under which Cloud Logging writes the exported log entries to the sink's destination. This field is either set by specifying custom_writer_identity or set automatically by sinks.create and sinks.update based on the value of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting Access for a Resource (https://cloud.google.com/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.Sinks that have a destination that is a log bucket in the same project as the sink cannot have a writer_identity and no additional permissions are required. }
@@ -233,7 +233,7 @@

Method Details

"name": "A String", # Required. The client-assigned sink identifier, unique within the project.For example: "my-syslog-errors-to-pubsub". Sink identifiers are limited to 100 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods. First character has to be alphanumeric. "outputVersionFormat": "A String", # Deprecated. This field is unused. "updateTime": "A String", # Output only. The last update timestamp of the sink.This field may not be present for older sinks. - "writerIdentity": "A String", # Output only. An IAM identity—a service account or group—under which Cloud Logging writes the exported log entries to the sink's destination. This field is set by sinks.create and sinks.update based on the value of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting Access for a Resource (https://cloud.google.com/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.Sinks that have a destination that is a log bucket in the same project as the sink do not have a writer_identity and no additional permissions are required. + "writerIdentity": "A String", # Output only. An IAM identity—a service account or group—under which Cloud Logging writes the exported log entries to the sink's destination. This field is either set by specifying custom_writer_identity or set automatically by sinks.create and sinks.update based on the value of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting Access for a Resource (https://cloud.google.com/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.Sinks that have a destination that is a log bucket in the same project as the sink cannot have a writer_identity and no additional permissions are required. }
@@ -280,7 +280,7 @@

Method Details

"name": "A String", # Required. The client-assigned sink identifier, unique within the project.For example: "my-syslog-errors-to-pubsub". Sink identifiers are limited to 100 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods. First character has to be alphanumeric. "outputVersionFormat": "A String", # Deprecated. This field is unused. "updateTime": "A String", # Output only. The last update timestamp of the sink.This field may not be present for older sinks. - "writerIdentity": "A String", # Output only. An IAM identity—a service account or group—under which Cloud Logging writes the exported log entries to the sink's destination. This field is set by sinks.create and sinks.update based on the value of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting Access for a Resource (https://cloud.google.com/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.Sinks that have a destination that is a log bucket in the same project as the sink do not have a writer_identity and no additional permissions are required. + "writerIdentity": "A String", # Output only. An IAM identity—a service account or group—under which Cloud Logging writes the exported log entries to the sink's destination. This field is either set by specifying custom_writer_identity or set automatically by sinks.create and sinks.update based on the value of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting Access for a Resource (https://cloud.google.com/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.Sinks that have a destination that is a log bucket in the same project as the sink cannot have a writer_identity and no additional permissions are required. }, ], }
@@ -333,7 +333,7 @@

Method Details

"name": "A String", # Required. The client-assigned sink identifier, unique within the project.For example: "my-syslog-errors-to-pubsub". Sink identifiers are limited to 100 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods. First character has to be alphanumeric. "outputVersionFormat": "A String", # Deprecated. This field is unused. "updateTime": "A String", # Output only. The last update timestamp of the sink.This field may not be present for older sinks. - "writerIdentity": "A String", # Output only. An IAM identity—a service account or group—under which Cloud Logging writes the exported log entries to the sink's destination. This field is set by sinks.create and sinks.update based on the value of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting Access for a Resource (https://cloud.google.com/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.Sinks that have a destination that is a log bucket in the same project as the sink do not have a writer_identity and no additional permissions are required. + "writerIdentity": "A String", # Output only. An IAM identity—a service account or group—under which Cloud Logging writes the exported log entries to the sink's destination. This field is either set by specifying custom_writer_identity or set automatically by sinks.create and sinks.update based on the value of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting Access for a Resource (https://cloud.google.com/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.Sinks that have a destination that is a log bucket in the same project as the sink cannot have a writer_identity and no additional permissions are required. } uniqueWriterIdentity: boolean, Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field: If the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity. If the old value is false and the new value is true, then writer_identity is changed to a unique service account. It is an error if the old value is true and the new value is set to false or defaulted to false. @@ -370,7 +370,7 @@

Method Details

"name": "A String", # Required. The client-assigned sink identifier, unique within the project.For example: "my-syslog-errors-to-pubsub". Sink identifiers are limited to 100 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods. First character has to be alphanumeric. "outputVersionFormat": "A String", # Deprecated. This field is unused. "updateTime": "A String", # Output only. The last update timestamp of the sink.This field may not be present for older sinks. - "writerIdentity": "A String", # Output only. An IAM identity—a service account or group—under which Cloud Logging writes the exported log entries to the sink's destination. This field is set by sinks.create and sinks.update based on the value of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting Access for a Resource (https://cloud.google.com/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.Sinks that have a destination that is a log bucket in the same project as the sink do not have a writer_identity and no additional permissions are required. + "writerIdentity": "A String", # Output only. An IAM identity—a service account or group—under which Cloud Logging writes the exported log entries to the sink's destination. This field is either set by specifying custom_writer_identity or set automatically by sinks.create and sinks.update based on the value of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting Access for a Resource (https://cloud.google.com/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.Sinks that have a destination that is a log bucket in the same project as the sink cannot have a writer_identity and no additional permissions are required. }
@@ -407,7 +407,7 @@

Method Details

"name": "A String", # Required. The client-assigned sink identifier, unique within the project.For example: "my-syslog-errors-to-pubsub". Sink identifiers are limited to 100 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods. First character has to be alphanumeric. "outputVersionFormat": "A String", # Deprecated. This field is unused. "updateTime": "A String", # Output only. The last update timestamp of the sink.This field may not be present for older sinks. - "writerIdentity": "A String", # Output only. An IAM identity—a service account or group—under which Cloud Logging writes the exported log entries to the sink's destination. This field is set by sinks.create and sinks.update based on the value of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting Access for a Resource (https://cloud.google.com/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.Sinks that have a destination that is a log bucket in the same project as the sink do not have a writer_identity and no additional permissions are required. + "writerIdentity": "A String", # Output only. An IAM identity—a service account or group—under which Cloud Logging writes the exported log entries to the sink's destination. This field is either set by specifying custom_writer_identity or set automatically by sinks.create and sinks.update based on the value of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting Access for a Resource (https://cloud.google.com/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.Sinks that have a destination that is a log bucket in the same project as the sink cannot have a writer_identity and no additional permissions are required. } uniqueWriterIdentity: boolean, Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field: If the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity. If the old value is false and the new value is true, then writer_identity is changed to a unique service account. It is an error if the old value is true and the new value is set to false or defaulted to false. @@ -444,7 +444,7 @@

Method Details

"name": "A String", # Required. The client-assigned sink identifier, unique within the project.For example: "my-syslog-errors-to-pubsub". Sink identifiers are limited to 100 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods. First character has to be alphanumeric. "outputVersionFormat": "A String", # Deprecated. This field is unused. "updateTime": "A String", # Output only. The last update timestamp of the sink.This field may not be present for older sinks. - "writerIdentity": "A String", # Output only. An IAM identity—a service account or group—under which Cloud Logging writes the exported log entries to the sink's destination. This field is set by sinks.create and sinks.update based on the value of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting Access for a Resource (https://cloud.google.com/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.Sinks that have a destination that is a log bucket in the same project as the sink do not have a writer_identity and no additional permissions are required. + "writerIdentity": "A String", # Output only. An IAM identity—a service account or group—under which Cloud Logging writes the exported log entries to the sink's destination. This field is either set by specifying custom_writer_identity or set automatically by sinks.create and sinks.update based on the value of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting Access for a Resource (https://cloud.google.com/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.Sinks that have a destination that is a log bucket in the same project as the sink cannot have a writer_identity and no additional permissions are required. } diff --git a/docs/dyn/logging_v2.organizations.sinks.html b/docs/dyn/logging_v2.organizations.sinks.html index e3e0d4195bb..b5f8d1daa0f 100644 --- a/docs/dyn/logging_v2.organizations.sinks.html +++ b/docs/dyn/logging_v2.organizations.sinks.html @@ -137,7 +137,7 @@

Method Details

"name": "A String", # Required. The client-assigned sink identifier, unique within the project.For example: "my-syslog-errors-to-pubsub". Sink identifiers are limited to 100 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods. First character has to be alphanumeric. "outputVersionFormat": "A String", # Deprecated. This field is unused. "updateTime": "A String", # Output only. The last update timestamp of the sink.This field may not be present for older sinks. - "writerIdentity": "A String", # Output only. An IAM identity—a service account or group—under which Cloud Logging writes the exported log entries to the sink's destination. This field is set by sinks.create and sinks.update based on the value of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting Access for a Resource (https://cloud.google.com/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.Sinks that have a destination that is a log bucket in the same project as the sink do not have a writer_identity and no additional permissions are required. + "writerIdentity": "A String", # Output only. An IAM identity—a service account or group—under which Cloud Logging writes the exported log entries to the sink's destination. This field is either set by specifying custom_writer_identity or set automatically by sinks.create and sinks.update based on the value of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting Access for a Resource (https://cloud.google.com/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.Sinks that have a destination that is a log bucket in the same project as the sink cannot have a writer_identity and no additional permissions are required. } uniqueWriterIdentity: boolean, Optional. Determines the kind of IAM identity returned as writer_identity in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value returned as writer_identity is the same group or service account used by Cloud Logging before the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself.If this field is set to true, or if the sink is owned by a non-project resource such as an organization, then the value of writer_identity will be a unique service account used only for exports from the new sink. For more information, see writer_identity in LogSink. @@ -173,7 +173,7 @@

Method Details

"name": "A String", # Required. The client-assigned sink identifier, unique within the project.For example: "my-syslog-errors-to-pubsub". Sink identifiers are limited to 100 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods. First character has to be alphanumeric. "outputVersionFormat": "A String", # Deprecated. This field is unused. "updateTime": "A String", # Output only. The last update timestamp of the sink.This field may not be present for older sinks. - "writerIdentity": "A String", # Output only. An IAM identity—a service account or group—under which Cloud Logging writes the exported log entries to the sink's destination. This field is set by sinks.create and sinks.update based on the value of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting Access for a Resource (https://cloud.google.com/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.Sinks that have a destination that is a log bucket in the same project as the sink do not have a writer_identity and no additional permissions are required. + "writerIdentity": "A String", # Output only. An IAM identity—a service account or group—under which Cloud Logging writes the exported log entries to the sink's destination. This field is either set by specifying custom_writer_identity or set automatically by sinks.create and sinks.update based on the value of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting Access for a Resource (https://cloud.google.com/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.Sinks that have a destination that is a log bucket in the same project as the sink cannot have a writer_identity and no additional permissions are required. } @@ -233,7 +233,7 @@

Method Details

"name": "A String", # Required. The client-assigned sink identifier, unique within the project.For example: "my-syslog-errors-to-pubsub". Sink identifiers are limited to 100 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods. First character has to be alphanumeric. "outputVersionFormat": "A String", # Deprecated. This field is unused. "updateTime": "A String", # Output only. The last update timestamp of the sink.This field may not be present for older sinks. - "writerIdentity": "A String", # Output only. An IAM identity—a service account or group—under which Cloud Logging writes the exported log entries to the sink's destination. This field is set by sinks.create and sinks.update based on the value of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting Access for a Resource (https://cloud.google.com/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.Sinks that have a destination that is a log bucket in the same project as the sink do not have a writer_identity and no additional permissions are required. + "writerIdentity": "A String", # Output only. An IAM identity—a service account or group—under which Cloud Logging writes the exported log entries to the sink's destination. This field is either set by specifying custom_writer_identity or set automatically by sinks.create and sinks.update based on the value of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting Access for a Resource (https://cloud.google.com/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.Sinks that have a destination that is a log bucket in the same project as the sink cannot have a writer_identity and no additional permissions are required. } @@ -280,7 +280,7 @@

Method Details

"name": "A String", # Required. The client-assigned sink identifier, unique within the project.For example: "my-syslog-errors-to-pubsub". Sink identifiers are limited to 100 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods. First character has to be alphanumeric. "outputVersionFormat": "A String", # Deprecated. This field is unused. "updateTime": "A String", # Output only. The last update timestamp of the sink.This field may not be present for older sinks. - "writerIdentity": "A String", # Output only. An IAM identity—a service account or group—under which Cloud Logging writes the exported log entries to the sink's destination. This field is set by sinks.create and sinks.update based on the value of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting Access for a Resource (https://cloud.google.com/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.Sinks that have a destination that is a log bucket in the same project as the sink do not have a writer_identity and no additional permissions are required. + "writerIdentity": "A String", # Output only. An IAM identity—a service account or group—under which Cloud Logging writes the exported log entries to the sink's destination. This field is either set by specifying custom_writer_identity or set automatically by sinks.create and sinks.update based on the value of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting Access for a Resource (https://cloud.google.com/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.Sinks that have a destination that is a log bucket in the same project as the sink cannot have a writer_identity and no additional permissions are required. }, ], } @@ -333,7 +333,7 @@

Method Details

"name": "A String", # Required. The client-assigned sink identifier, unique within the project.For example: "my-syslog-errors-to-pubsub". Sink identifiers are limited to 100 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods. First character has to be alphanumeric. "outputVersionFormat": "A String", # Deprecated. This field is unused. "updateTime": "A String", # Output only. The last update timestamp of the sink.This field may not be present for older sinks. - "writerIdentity": "A String", # Output only. An IAM identity—a service account or group—under which Cloud Logging writes the exported log entries to the sink's destination. This field is set by sinks.create and sinks.update based on the value of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting Access for a Resource (https://cloud.google.com/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.Sinks that have a destination that is a log bucket in the same project as the sink do not have a writer_identity and no additional permissions are required. + "writerIdentity": "A String", # Output only. An IAM identity—a service account or group—under which Cloud Logging writes the exported log entries to the sink's destination. This field is either set by specifying custom_writer_identity or set automatically by sinks.create and sinks.update based on the value of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting Access for a Resource (https://cloud.google.com/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.Sinks that have a destination that is a log bucket in the same project as the sink cannot have a writer_identity and no additional permissions are required. } uniqueWriterIdentity: boolean, Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field: If the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity. If the old value is false and the new value is true, then writer_identity is changed to a unique service account. It is an error if the old value is true and the new value is set to false or defaulted to false. @@ -370,7 +370,7 @@

Method Details

"name": "A String", # Required. The client-assigned sink identifier, unique within the project.For example: "my-syslog-errors-to-pubsub". Sink identifiers are limited to 100 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods. First character has to be alphanumeric. "outputVersionFormat": "A String", # Deprecated. This field is unused. "updateTime": "A String", # Output only. The last update timestamp of the sink.This field may not be present for older sinks. - "writerIdentity": "A String", # Output only. An IAM identity—a service account or group—under which Cloud Logging writes the exported log entries to the sink's destination. This field is set by sinks.create and sinks.update based on the value of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting Access for a Resource (https://cloud.google.com/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.Sinks that have a destination that is a log bucket in the same project as the sink do not have a writer_identity and no additional permissions are required. + "writerIdentity": "A String", # Output only. An IAM identity—a service account or group—under which Cloud Logging writes the exported log entries to the sink's destination. This field is either set by specifying custom_writer_identity or set automatically by sinks.create and sinks.update based on the value of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting Access for a Resource (https://cloud.google.com/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.Sinks that have a destination that is a log bucket in the same project as the sink cannot have a writer_identity and no additional permissions are required. } @@ -407,7 +407,7 @@

Method Details

"name": "A String", # Required. The client-assigned sink identifier, unique within the project.For example: "my-syslog-errors-to-pubsub". Sink identifiers are limited to 100 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods. First character has to be alphanumeric. "outputVersionFormat": "A String", # Deprecated. This field is unused. "updateTime": "A String", # Output only. The last update timestamp of the sink.This field may not be present for older sinks. - "writerIdentity": "A String", # Output only. An IAM identity—a service account or group—under which Cloud Logging writes the exported log entries to the sink's destination. This field is set by sinks.create and sinks.update based on the value of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting Access for a Resource (https://cloud.google.com/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.Sinks that have a destination that is a log bucket in the same project as the sink do not have a writer_identity and no additional permissions are required. + "writerIdentity": "A String", # Output only. An IAM identity—a service account or group—under which Cloud Logging writes the exported log entries to the sink's destination. This field is either set by specifying custom_writer_identity or set automatically by sinks.create and sinks.update based on the value of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting Access for a Resource (https://cloud.google.com/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.Sinks that have a destination that is a log bucket in the same project as the sink cannot have a writer_identity and no additional permissions are required. } uniqueWriterIdentity: boolean, Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field: If the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity. If the old value is false and the new value is true, then writer_identity is changed to a unique service account. It is an error if the old value is true and the new value is set to false or defaulted to false. @@ -444,7 +444,7 @@

Method Details

"name": "A String", # Required. The client-assigned sink identifier, unique within the project.For example: "my-syslog-errors-to-pubsub". Sink identifiers are limited to 100 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods. First character has to be alphanumeric. "outputVersionFormat": "A String", # Deprecated. This field is unused. "updateTime": "A String", # Output only. The last update timestamp of the sink.This field may not be present for older sinks. - "writerIdentity": "A String", # Output only. An IAM identity—a service account or group—under which Cloud Logging writes the exported log entries to the sink's destination. This field is set by sinks.create and sinks.update based on the value of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting Access for a Resource (https://cloud.google.com/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.Sinks that have a destination that is a log bucket in the same project as the sink do not have a writer_identity and no additional permissions are required. + "writerIdentity": "A String", # Output only. An IAM identity—a service account or group—under which Cloud Logging writes the exported log entries to the sink's destination. This field is either set by specifying custom_writer_identity or set automatically by sinks.create and sinks.update based on the value of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting Access for a Resource (https://cloud.google.com/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.Sinks that have a destination that is a log bucket in the same project as the sink cannot have a writer_identity and no additional permissions are required. } diff --git a/docs/dyn/logging_v2.projects.sinks.html b/docs/dyn/logging_v2.projects.sinks.html index 07b3f714661..b7adf226ea5 100644 --- a/docs/dyn/logging_v2.projects.sinks.html +++ b/docs/dyn/logging_v2.projects.sinks.html @@ -137,7 +137,7 @@

Method Details

"name": "A String", # Required. The client-assigned sink identifier, unique within the project.For example: "my-syslog-errors-to-pubsub". Sink identifiers are limited to 100 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods. First character has to be alphanumeric. "outputVersionFormat": "A String", # Deprecated. This field is unused. "updateTime": "A String", # Output only. The last update timestamp of the sink.This field may not be present for older sinks. - "writerIdentity": "A String", # Output only. An IAM identity—a service account or group—under which Cloud Logging writes the exported log entries to the sink's destination. This field is set by sinks.create and sinks.update based on the value of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting Access for a Resource (https://cloud.google.com/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.Sinks that have a destination that is a log bucket in the same project as the sink do not have a writer_identity and no additional permissions are required. + "writerIdentity": "A String", # Output only. An IAM identity—a service account or group—under which Cloud Logging writes the exported log entries to the sink's destination. This field is either set by specifying custom_writer_identity or set automatically by sinks.create and sinks.update based on the value of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting Access for a Resource (https://cloud.google.com/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.Sinks that have a destination that is a log bucket in the same project as the sink cannot have a writer_identity and no additional permissions are required. } uniqueWriterIdentity: boolean, Optional. Determines the kind of IAM identity returned as writer_identity in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value returned as writer_identity is the same group or service account used by Cloud Logging before the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself.If this field is set to true, or if the sink is owned by a non-project resource such as an organization, then the value of writer_identity will be a unique service account used only for exports from the new sink. For more information, see writer_identity in LogSink. @@ -173,7 +173,7 @@

Method Details

"name": "A String", # Required. The client-assigned sink identifier, unique within the project.For example: "my-syslog-errors-to-pubsub". Sink identifiers are limited to 100 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods. First character has to be alphanumeric. "outputVersionFormat": "A String", # Deprecated. This field is unused. "updateTime": "A String", # Output only. The last update timestamp of the sink.This field may not be present for older sinks. - "writerIdentity": "A String", # Output only. An IAM identity—a service account or group—under which Cloud Logging writes the exported log entries to the sink's destination. This field is set by sinks.create and sinks.update based on the value of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting Access for a Resource (https://cloud.google.com/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.Sinks that have a destination that is a log bucket in the same project as the sink do not have a writer_identity and no additional permissions are required. + "writerIdentity": "A String", # Output only. An IAM identity—a service account or group—under which Cloud Logging writes the exported log entries to the sink's destination. This field is either set by specifying custom_writer_identity or set automatically by sinks.create and sinks.update based on the value of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting Access for a Resource (https://cloud.google.com/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.Sinks that have a destination that is a log bucket in the same project as the sink cannot have a writer_identity and no additional permissions are required. } @@ -233,7 +233,7 @@

Method Details

"name": "A String", # Required. The client-assigned sink identifier, unique within the project.For example: "my-syslog-errors-to-pubsub". Sink identifiers are limited to 100 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods. First character has to be alphanumeric. "outputVersionFormat": "A String", # Deprecated. This field is unused. "updateTime": "A String", # Output only. The last update timestamp of the sink.This field may not be present for older sinks. - "writerIdentity": "A String", # Output only. An IAM identity—a service account or group—under which Cloud Logging writes the exported log entries to the sink's destination. This field is set by sinks.create and sinks.update based on the value of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting Access for a Resource (https://cloud.google.com/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.Sinks that have a destination that is a log bucket in the same project as the sink do not have a writer_identity and no additional permissions are required. + "writerIdentity": "A String", # Output only. An IAM identity—a service account or group—under which Cloud Logging writes the exported log entries to the sink's destination. This field is either set by specifying custom_writer_identity or set automatically by sinks.create and sinks.update based on the value of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting Access for a Resource (https://cloud.google.com/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.Sinks that have a destination that is a log bucket in the same project as the sink cannot have a writer_identity and no additional permissions are required. } @@ -280,7 +280,7 @@

Method Details

"name": "A String", # Required. The client-assigned sink identifier, unique within the project.For example: "my-syslog-errors-to-pubsub". Sink identifiers are limited to 100 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods. First character has to be alphanumeric. "outputVersionFormat": "A String", # Deprecated. This field is unused. "updateTime": "A String", # Output only. The last update timestamp of the sink.This field may not be present for older sinks. - "writerIdentity": "A String", # Output only. An IAM identity—a service account or group—under which Cloud Logging writes the exported log entries to the sink's destination. This field is set by sinks.create and sinks.update based on the value of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting Access for a Resource (https://cloud.google.com/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.Sinks that have a destination that is a log bucket in the same project as the sink do not have a writer_identity and no additional permissions are required. + "writerIdentity": "A String", # Output only. An IAM identity—a service account or group—under which Cloud Logging writes the exported log entries to the sink's destination. This field is either set by specifying custom_writer_identity or set automatically by sinks.create and sinks.update based on the value of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting Access for a Resource (https://cloud.google.com/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.Sinks that have a destination that is a log bucket in the same project as the sink cannot have a writer_identity and no additional permissions are required. }, ], } @@ -333,7 +333,7 @@

Method Details

"name": "A String", # Required. The client-assigned sink identifier, unique within the project.For example: "my-syslog-errors-to-pubsub". Sink identifiers are limited to 100 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods. First character has to be alphanumeric. "outputVersionFormat": "A String", # Deprecated. This field is unused. "updateTime": "A String", # Output only. The last update timestamp of the sink.This field may not be present for older sinks. - "writerIdentity": "A String", # Output only. An IAM identity—a service account or group—under which Cloud Logging writes the exported log entries to the sink's destination. This field is set by sinks.create and sinks.update based on the value of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting Access for a Resource (https://cloud.google.com/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.Sinks that have a destination that is a log bucket in the same project as the sink do not have a writer_identity and no additional permissions are required. + "writerIdentity": "A String", # Output only. An IAM identity—a service account or group—under which Cloud Logging writes the exported log entries to the sink's destination. This field is either set by specifying custom_writer_identity or set automatically by sinks.create and sinks.update based on the value of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting Access for a Resource (https://cloud.google.com/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.Sinks that have a destination that is a log bucket in the same project as the sink cannot have a writer_identity and no additional permissions are required. } uniqueWriterIdentity: boolean, Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field: If the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity. If the old value is false and the new value is true, then writer_identity is changed to a unique service account. It is an error if the old value is true and the new value is set to false or defaulted to false. @@ -370,7 +370,7 @@

Method Details

"name": "A String", # Required. The client-assigned sink identifier, unique within the project.For example: "my-syslog-errors-to-pubsub". Sink identifiers are limited to 100 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods. First character has to be alphanumeric. "outputVersionFormat": "A String", # Deprecated. This field is unused. "updateTime": "A String", # Output only. The last update timestamp of the sink.This field may not be present for older sinks. - "writerIdentity": "A String", # Output only. An IAM identity—a service account or group—under which Cloud Logging writes the exported log entries to the sink's destination. This field is set by sinks.create and sinks.update based on the value of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting Access for a Resource (https://cloud.google.com/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.Sinks that have a destination that is a log bucket in the same project as the sink do not have a writer_identity and no additional permissions are required. + "writerIdentity": "A String", # Output only. An IAM identity—a service account or group—under which Cloud Logging writes the exported log entries to the sink's destination. This field is either set by specifying custom_writer_identity or set automatically by sinks.create and sinks.update based on the value of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting Access for a Resource (https://cloud.google.com/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.Sinks that have a destination that is a log bucket in the same project as the sink cannot have a writer_identity and no additional permissions are required. } @@ -407,7 +407,7 @@

Method Details

"name": "A String", # Required. The client-assigned sink identifier, unique within the project.For example: "my-syslog-errors-to-pubsub". Sink identifiers are limited to 100 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods. First character has to be alphanumeric. "outputVersionFormat": "A String", # Deprecated. This field is unused. "updateTime": "A String", # Output only. The last update timestamp of the sink.This field may not be present for older sinks. - "writerIdentity": "A String", # Output only. An IAM identity—a service account or group—under which Cloud Logging writes the exported log entries to the sink's destination. This field is set by sinks.create and sinks.update based on the value of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting Access for a Resource (https://cloud.google.com/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.Sinks that have a destination that is a log bucket in the same project as the sink do not have a writer_identity and no additional permissions are required. + "writerIdentity": "A String", # Output only. An IAM identity—a service account or group—under which Cloud Logging writes the exported log entries to the sink's destination. This field is either set by specifying custom_writer_identity or set automatically by sinks.create and sinks.update based on the value of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting Access for a Resource (https://cloud.google.com/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.Sinks that have a destination that is a log bucket in the same project as the sink cannot have a writer_identity and no additional permissions are required. } uniqueWriterIdentity: boolean, Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field: If the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity. If the old value is false and the new value is true, then writer_identity is changed to a unique service account. It is an error if the old value is true and the new value is set to false or defaulted to false. @@ -444,7 +444,7 @@

Method Details

"name": "A String", # Required. The client-assigned sink identifier, unique within the project.For example: "my-syslog-errors-to-pubsub". Sink identifiers are limited to 100 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods. First character has to be alphanumeric. "outputVersionFormat": "A String", # Deprecated. This field is unused. "updateTime": "A String", # Output only. The last update timestamp of the sink.This field may not be present for older sinks. - "writerIdentity": "A String", # Output only. An IAM identity—a service account or group—under which Cloud Logging writes the exported log entries to the sink's destination. This field is set by sinks.create and sinks.update based on the value of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting Access for a Resource (https://cloud.google.com/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.Sinks that have a destination that is a log bucket in the same project as the sink do not have a writer_identity and no additional permissions are required. + "writerIdentity": "A String", # Output only. An IAM identity—a service account or group—under which Cloud Logging writes the exported log entries to the sink's destination. This field is either set by specifying custom_writer_identity or set automatically by sinks.create and sinks.update based on the value of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting Access for a Resource (https://cloud.google.com/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.Sinks that have a destination that is a log bucket in the same project as the sink cannot have a writer_identity and no additional permissions are required. } diff --git a/docs/dyn/logging_v2.sinks.html b/docs/dyn/logging_v2.sinks.html index 87934d38301..1c7515dec3a 100644 --- a/docs/dyn/logging_v2.sinks.html +++ b/docs/dyn/logging_v2.sinks.html @@ -134,7 +134,7 @@

Method Details

"name": "A String", # Required. The client-assigned sink identifier, unique within the project.For example: "my-syslog-errors-to-pubsub". Sink identifiers are limited to 100 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods. First character has to be alphanumeric. "outputVersionFormat": "A String", # Deprecated. This field is unused. "updateTime": "A String", # Output only. The last update timestamp of the sink.This field may not be present for older sinks. - "writerIdentity": "A String", # Output only. An IAM identity—a service account or group—under which Cloud Logging writes the exported log entries to the sink's destination. This field is set by sinks.create and sinks.update based on the value of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting Access for a Resource (https://cloud.google.com/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.Sinks that have a destination that is a log bucket in the same project as the sink do not have a writer_identity and no additional permissions are required. + "writerIdentity": "A String", # Output only. An IAM identity—a service account or group—under which Cloud Logging writes the exported log entries to the sink's destination. This field is either set by specifying custom_writer_identity or set automatically by sinks.create and sinks.update based on the value of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting Access for a Resource (https://cloud.google.com/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.Sinks that have a destination that is a log bucket in the same project as the sink cannot have a writer_identity and no additional permissions are required. } uniqueWriterIdentity: boolean, Optional. Determines the kind of IAM identity returned as writer_identity in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value returned as writer_identity is the same group or service account used by Cloud Logging before the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself.If this field is set to true, or if the sink is owned by a non-project resource such as an organization, then the value of writer_identity will be a unique service account used only for exports from the new sink. For more information, see writer_identity in LogSink. @@ -170,7 +170,7 @@

Method Details

"name": "A String", # Required. The client-assigned sink identifier, unique within the project.For example: "my-syslog-errors-to-pubsub". Sink identifiers are limited to 100 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods. First character has to be alphanumeric. "outputVersionFormat": "A String", # Deprecated. This field is unused. "updateTime": "A String", # Output only. The last update timestamp of the sink.This field may not be present for older sinks. - "writerIdentity": "A String", # Output only. An IAM identity—a service account or group—under which Cloud Logging writes the exported log entries to the sink's destination. This field is set by sinks.create and sinks.update based on the value of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting Access for a Resource (https://cloud.google.com/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.Sinks that have a destination that is a log bucket in the same project as the sink do not have a writer_identity and no additional permissions are required. + "writerIdentity": "A String", # Output only. An IAM identity—a service account or group—under which Cloud Logging writes the exported log entries to the sink's destination. This field is either set by specifying custom_writer_identity or set automatically by sinks.create and sinks.update based on the value of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting Access for a Resource (https://cloud.google.com/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.Sinks that have a destination that is a log bucket in the same project as the sink cannot have a writer_identity and no additional permissions are required. } @@ -230,7 +230,7 @@

Method Details

"name": "A String", # Required. The client-assigned sink identifier, unique within the project.For example: "my-syslog-errors-to-pubsub". Sink identifiers are limited to 100 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods. First character has to be alphanumeric. "outputVersionFormat": "A String", # Deprecated. This field is unused. "updateTime": "A String", # Output only. The last update timestamp of the sink.This field may not be present for older sinks. - "writerIdentity": "A String", # Output only. An IAM identity—a service account or group—under which Cloud Logging writes the exported log entries to the sink's destination. This field is set by sinks.create and sinks.update based on the value of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting Access for a Resource (https://cloud.google.com/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.Sinks that have a destination that is a log bucket in the same project as the sink do not have a writer_identity and no additional permissions are required. + "writerIdentity": "A String", # Output only. An IAM identity—a service account or group—under which Cloud Logging writes the exported log entries to the sink's destination. This field is either set by specifying custom_writer_identity or set automatically by sinks.create and sinks.update based on the value of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting Access for a Resource (https://cloud.google.com/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.Sinks that have a destination that is a log bucket in the same project as the sink cannot have a writer_identity and no additional permissions are required. } @@ -277,7 +277,7 @@

Method Details

"name": "A String", # Required. The client-assigned sink identifier, unique within the project.For example: "my-syslog-errors-to-pubsub". Sink identifiers are limited to 100 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods. First character has to be alphanumeric. "outputVersionFormat": "A String", # Deprecated. This field is unused. "updateTime": "A String", # Output only. The last update timestamp of the sink.This field may not be present for older sinks. - "writerIdentity": "A String", # Output only. An IAM identity—a service account or group—under which Cloud Logging writes the exported log entries to the sink's destination. This field is set by sinks.create and sinks.update based on the value of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting Access for a Resource (https://cloud.google.com/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.Sinks that have a destination that is a log bucket in the same project as the sink do not have a writer_identity and no additional permissions are required. + "writerIdentity": "A String", # Output only. An IAM identity—a service account or group—under which Cloud Logging writes the exported log entries to the sink's destination. This field is either set by specifying custom_writer_identity or set automatically by sinks.create and sinks.update based on the value of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting Access for a Resource (https://cloud.google.com/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.Sinks that have a destination that is a log bucket in the same project as the sink cannot have a writer_identity and no additional permissions are required. }, ], } @@ -330,7 +330,7 @@

Method Details

"name": "A String", # Required. The client-assigned sink identifier, unique within the project.For example: "my-syslog-errors-to-pubsub". Sink identifiers are limited to 100 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods. First character has to be alphanumeric. "outputVersionFormat": "A String", # Deprecated. This field is unused. "updateTime": "A String", # Output only. The last update timestamp of the sink.This field may not be present for older sinks. - "writerIdentity": "A String", # Output only. An IAM identity—a service account or group—under which Cloud Logging writes the exported log entries to the sink's destination. This field is set by sinks.create and sinks.update based on the value of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting Access for a Resource (https://cloud.google.com/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.Sinks that have a destination that is a log bucket in the same project as the sink do not have a writer_identity and no additional permissions are required. + "writerIdentity": "A String", # Output only. An IAM identity—a service account or group—under which Cloud Logging writes the exported log entries to the sink's destination. This field is either set by specifying custom_writer_identity or set automatically by sinks.create and sinks.update based on the value of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting Access for a Resource (https://cloud.google.com/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.Sinks that have a destination that is a log bucket in the same project as the sink cannot have a writer_identity and no additional permissions are required. } uniqueWriterIdentity: boolean, Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field: If the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity. If the old value is false and the new value is true, then writer_identity is changed to a unique service account. It is an error if the old value is true and the new value is set to false or defaulted to false. @@ -367,7 +367,7 @@

Method Details

"name": "A String", # Required. The client-assigned sink identifier, unique within the project.For example: "my-syslog-errors-to-pubsub". Sink identifiers are limited to 100 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods. First character has to be alphanumeric. "outputVersionFormat": "A String", # Deprecated. This field is unused. "updateTime": "A String", # Output only. The last update timestamp of the sink.This field may not be present for older sinks. - "writerIdentity": "A String", # Output only. An IAM identity—a service account or group—under which Cloud Logging writes the exported log entries to the sink's destination. This field is set by sinks.create and sinks.update based on the value of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting Access for a Resource (https://cloud.google.com/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.Sinks that have a destination that is a log bucket in the same project as the sink do not have a writer_identity and no additional permissions are required. + "writerIdentity": "A String", # Output only. An IAM identity—a service account or group—under which Cloud Logging writes the exported log entries to the sink's destination. This field is either set by specifying custom_writer_identity or set automatically by sinks.create and sinks.update based on the value of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting Access for a Resource (https://cloud.google.com/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.Sinks that have a destination that is a log bucket in the same project as the sink cannot have a writer_identity and no additional permissions are required. } diff --git a/docs/dyn/networksecurity_v1.projects.locations.authorizationPolicies.html b/docs/dyn/networksecurity_v1.projects.locations.authorizationPolicies.html index 5fac70065c0..6c1950dc5f8 100644 --- a/docs/dyn/networksecurity_v1.projects.locations.authorizationPolicies.html +++ b/docs/dyn/networksecurity_v1.projects.locations.authorizationPolicies.html @@ -131,10 +131,10 @@

Method Details

{ # Specification of rules. "destinations": [ # Optional. List of attributes for the traffic destination. All of the destinations must match. A destination is a match if a request matches all the specified hosts, ports, methods and headers. If not set, the action specified in the 'action' field will be applied without any rule checks for the destination. { # Specification of traffic destination attributes. - "hosts": [ # Required. List of host names to match. Matched against the ":authority" header in http requests. At least one host should match. Each host can be an exact match, or a prefix match (example "mydomain.*") or a suffix match (example // *.myorg.com") or a presence(any) match "*". + "hosts": [ # Required. List of host names to match. Matched against the ":authority" header in http requests. At least one host should match. Each host can be an exact match, or a prefix match (example "mydomain.*") or a suffix match (example "*.myorg.com") or a presence (any) match "*". "A String", ], - "httpHeaderMatch": { # Specification of HTTP header match atrributes. # Optional. Match against key:value pair in http header. Provides a flexible match based on HTTP headers, for potentially advanced use cases. At least one header should match. Avoid using header matches to make authorization decisions unless there is a strong guarantee that requests arrive through a trusted client or proxy. + "httpHeaderMatch": { # Specification of HTTP header match attributes. # Optional. Match against key:value pair in http header. Provides a flexible match based on HTTP headers, for potentially advanced use cases. At least one header should match. Avoid using header matches to make authorization decisions unless there is a strong guarantee that requests arrive through a trusted client or proxy. "headerName": "A String", # Required. The name of the HTTP header to match. For matching against the HTTP request's authority, use a headerMatch with the header name ":authority". For matching a request's method, use the headerName ":method". "regexMatch": "A String", # Required. The value of the header must match the regular expression specified in regexMatch. For regular expression grammar, please see: en.cppreference.com/w/cpp/regex/ecmascript For matching against a port specified in the HTTP request, use a headerMatch with headerName set to Host and a regular expression that satisfies the RFC2616 Host header's port specifier. }, @@ -151,7 +151,7 @@

Method Details

"ipBlocks": [ # Optional. List of CIDR ranges to match based on source IP address. At least one IP block should match. Single IP (e.g., "1.2.3.4") and CIDR (e.g., "1.2.3.0/24") are supported. Authorization based on source IP alone should be avoided. The IP addresses of any load balancers or proxies should be considered untrusted. "A String", ], - "principals": [ # Optional. List of peer identities to match for authorization. At least one principal should match. Each peer can be an exact match, or a prefix match (example, "namespace/*") or a suffix match (example, // */service-account") or a presence match "*". Authorization based on the principal name without certificate validation (configured by ServerTlsPolicy resource) is considered insecure. + "principals": [ # Optional. List of peer identities to match for authorization. At least one principal should match. Each peer can be an exact match, or a prefix match (example, "namespace/*") or a suffix match (example, "*/service-account") or a presence match "*". Authorization based on the principal name without certificate validation (configured by ServerTlsPolicy resource) is considered insecure. "A String", ], }, @@ -252,10 +252,10 @@

Method Details

{ # Specification of rules. "destinations": [ # Optional. List of attributes for the traffic destination. All of the destinations must match. A destination is a match if a request matches all the specified hosts, ports, methods and headers. If not set, the action specified in the 'action' field will be applied without any rule checks for the destination. { # Specification of traffic destination attributes. - "hosts": [ # Required. List of host names to match. Matched against the ":authority" header in http requests. At least one host should match. Each host can be an exact match, or a prefix match (example "mydomain.*") or a suffix match (example // *.myorg.com") or a presence(any) match "*". + "hosts": [ # Required. List of host names to match. Matched against the ":authority" header in http requests. At least one host should match. Each host can be an exact match, or a prefix match (example "mydomain.*") or a suffix match (example "*.myorg.com") or a presence (any) match "*". "A String", ], - "httpHeaderMatch": { # Specification of HTTP header match atrributes. # Optional. Match against key:value pair in http header. Provides a flexible match based on HTTP headers, for potentially advanced use cases. At least one header should match. Avoid using header matches to make authorization decisions unless there is a strong guarantee that requests arrive through a trusted client or proxy. + "httpHeaderMatch": { # Specification of HTTP header match attributes. # Optional. Match against key:value pair in http header. Provides a flexible match based on HTTP headers, for potentially advanced use cases. At least one header should match. Avoid using header matches to make authorization decisions unless there is a strong guarantee that requests arrive through a trusted client or proxy. "headerName": "A String", # Required. The name of the HTTP header to match. For matching against the HTTP request's authority, use a headerMatch with the header name ":authority". For matching a request's method, use the headerName ":method". "regexMatch": "A String", # Required. The value of the header must match the regular expression specified in regexMatch. For regular expression grammar, please see: en.cppreference.com/w/cpp/regex/ecmascript For matching against a port specified in the HTTP request, use a headerMatch with headerName set to Host and a regular expression that satisfies the RFC2616 Host header's port specifier. }, @@ -272,7 +272,7 @@

Method Details

"ipBlocks": [ # Optional. List of CIDR ranges to match based on source IP address. At least one IP block should match. Single IP (e.g., "1.2.3.4") and CIDR (e.g., "1.2.3.0/24") are supported. Authorization based on source IP alone should be avoided. The IP addresses of any load balancers or proxies should be considered untrusted. "A String", ], - "principals": [ # Optional. List of peer identities to match for authorization. At least one principal should match. Each peer can be an exact match, or a prefix match (example, "namespace/*") or a suffix match (example, // */service-account") or a presence match "*". Authorization based on the principal name without certificate validation (configured by ServerTlsPolicy resource) is considered insecure. + "principals": [ # Optional. List of peer identities to match for authorization. At least one principal should match. Each peer can be an exact match, or a prefix match (example, "namespace/*") or a suffix match (example, "*/service-account") or a presence match "*". Authorization based on the principal name without certificate validation (configured by ServerTlsPolicy resource) is considered insecure. "A String", ], }, @@ -361,10 +361,10 @@

Method Details

{ # Specification of rules. "destinations": [ # Optional. List of attributes for the traffic destination. All of the destinations must match. A destination is a match if a request matches all the specified hosts, ports, methods and headers. If not set, the action specified in the 'action' field will be applied without any rule checks for the destination. { # Specification of traffic destination attributes. - "hosts": [ # Required. List of host names to match. Matched against the ":authority" header in http requests. At least one host should match. Each host can be an exact match, or a prefix match (example "mydomain.*") or a suffix match (example // *.myorg.com") or a presence(any) match "*". + "hosts": [ # Required. List of host names to match. Matched against the ":authority" header in http requests. At least one host should match. Each host can be an exact match, or a prefix match (example "mydomain.*") or a suffix match (example "*.myorg.com") or a presence (any) match "*". "A String", ], - "httpHeaderMatch": { # Specification of HTTP header match atrributes. # Optional. Match against key:value pair in http header. Provides a flexible match based on HTTP headers, for potentially advanced use cases. At least one header should match. Avoid using header matches to make authorization decisions unless there is a strong guarantee that requests arrive through a trusted client or proxy. + "httpHeaderMatch": { # Specification of HTTP header match attributes. # Optional. Match against key:value pair in http header. Provides a flexible match based on HTTP headers, for potentially advanced use cases. At least one header should match. Avoid using header matches to make authorization decisions unless there is a strong guarantee that requests arrive through a trusted client or proxy. "headerName": "A String", # Required. The name of the HTTP header to match. For matching against the HTTP request's authority, use a headerMatch with the header name ":authority". For matching a request's method, use the headerName ":method". "regexMatch": "A String", # Required. The value of the header must match the regular expression specified in regexMatch. For regular expression grammar, please see: en.cppreference.com/w/cpp/regex/ecmascript For matching against a port specified in the HTTP request, use a headerMatch with headerName set to Host and a regular expression that satisfies the RFC2616 Host header's port specifier. }, @@ -381,7 +381,7 @@

Method Details

"ipBlocks": [ # Optional. List of CIDR ranges to match based on source IP address. At least one IP block should match. Single IP (e.g., "1.2.3.4") and CIDR (e.g., "1.2.3.0/24") are supported. Authorization based on source IP alone should be avoided. The IP addresses of any load balancers or proxies should be considered untrusted. "A String", ], - "principals": [ # Optional. List of peer identities to match for authorization. At least one principal should match. Each peer can be an exact match, or a prefix match (example, "namespace/*") or a suffix match (example, // */service-account") or a presence match "*". Authorization based on the principal name without certificate validation (configured by ServerTlsPolicy resource) is considered insecure. + "principals": [ # Optional. List of peer identities to match for authorization. At least one principal should match. Each peer can be an exact match, or a prefix match (example, "namespace/*") or a suffix match (example, "*/service-account") or a presence match "*". Authorization based on the principal name without certificate validation (configured by ServerTlsPolicy resource) is considered insecure. "A String", ], }, @@ -430,10 +430,10 @@

Method Details

{ # Specification of rules. "destinations": [ # Optional. List of attributes for the traffic destination. All of the destinations must match. A destination is a match if a request matches all the specified hosts, ports, methods and headers. If not set, the action specified in the 'action' field will be applied without any rule checks for the destination. { # Specification of traffic destination attributes. - "hosts": [ # Required. List of host names to match. Matched against the ":authority" header in http requests. At least one host should match. Each host can be an exact match, or a prefix match (example "mydomain.*") or a suffix match (example // *.myorg.com") or a presence(any) match "*". + "hosts": [ # Required. List of host names to match. Matched against the ":authority" header in http requests. At least one host should match. Each host can be an exact match, or a prefix match (example "mydomain.*") or a suffix match (example "*.myorg.com") or a presence (any) match "*". "A String", ], - "httpHeaderMatch": { # Specification of HTTP header match atrributes. # Optional. Match against key:value pair in http header. Provides a flexible match based on HTTP headers, for potentially advanced use cases. At least one header should match. Avoid using header matches to make authorization decisions unless there is a strong guarantee that requests arrive through a trusted client or proxy. + "httpHeaderMatch": { # Specification of HTTP header match attributes. # Optional. Match against key:value pair in http header. Provides a flexible match based on HTTP headers, for potentially advanced use cases. At least one header should match. Avoid using header matches to make authorization decisions unless there is a strong guarantee that requests arrive through a trusted client or proxy. "headerName": "A String", # Required. The name of the HTTP header to match. For matching against the HTTP request's authority, use a headerMatch with the header name ":authority". For matching a request's method, use the headerName ":method". "regexMatch": "A String", # Required. The value of the header must match the regular expression specified in regexMatch. For regular expression grammar, please see: en.cppreference.com/w/cpp/regex/ecmascript For matching against a port specified in the HTTP request, use a headerMatch with headerName set to Host and a regular expression that satisfies the RFC2616 Host header's port specifier. }, @@ -450,7 +450,7 @@

Method Details

"ipBlocks": [ # Optional. List of CIDR ranges to match based on source IP address. At least one IP block should match. Single IP (e.g., "1.2.3.4") and CIDR (e.g., "1.2.3.0/24") are supported. Authorization based on source IP alone should be avoided. The IP addresses of any load balancers or proxies should be considered untrusted. "A String", ], - "principals": [ # Optional. List of peer identities to match for authorization. At least one principal should match. Each peer can be an exact match, or a prefix match (example, "namespace/*") or a suffix match (example, // */service-account") or a presence match "*". Authorization based on the principal name without certificate validation (configured by ServerTlsPolicy resource) is considered insecure. + "principals": [ # Optional. List of peer identities to match for authorization. At least one principal should match. Each peer can be an exact match, or a prefix match (example, "namespace/*") or a suffix match (example, "*/service-account") or a presence match "*". Authorization based on the principal name without certificate validation (configured by ServerTlsPolicy resource) is considered insecure. "A String", ], }, diff --git a/docs/dyn/networksecurity_v1.projects.locations.clientTlsPolicies.html b/docs/dyn/networksecurity_v1.projects.locations.clientTlsPolicies.html index 88fada63bd5..b30b5ae10d5 100644 --- a/docs/dyn/networksecurity_v1.projects.locations.clientTlsPolicies.html +++ b/docs/dyn/networksecurity_v1.projects.locations.clientTlsPolicies.html @@ -125,7 +125,7 @@

Method Details

"pluginInstance": "A String", # Required. Plugin instance name, used to locate and load CertificateProvider instance configuration. Set to "google_cloud_private_spiffe" to use Certificate Authority Service certificate provider instance. }, "grpcEndpoint": { # Specification of the GRPC Endpoint. # gRPC specific configuration to access the gRPC server to obtain the cert and private key. - "targetUri": "A String", # Required. The target URI of the gRPC endpoint. Only UDS path is supported, and should start with “unix:”. + "targetUri": "A String", # Required. The target URI of the gRPC endpoint. Only UDS path is supported, and should start with "unix:". }, }, "createTime": "A String", # Output only. The timestamp when the resource was created. @@ -140,7 +140,7 @@

Method Details

"pluginInstance": "A String", # Required. Plugin instance name, used to locate and load CertificateProvider instance configuration. Set to "google_cloud_private_spiffe" to use Certificate Authority Service certificate provider instance. }, "grpcEndpoint": { # Specification of the GRPC Endpoint. # gRPC specific configuration to access the gRPC server to obtain the CA certificate. - "targetUri": "A String", # Required. The target URI of the gRPC endpoint. Only UDS path is supported, and should start with “unix:”. + "targetUri": "A String", # Required. The target URI of the gRPC endpoint. Only UDS path is supported, and should start with "unix:". }, }, ], @@ -233,7 +233,7 @@

Method Details

"pluginInstance": "A String", # Required. Plugin instance name, used to locate and load CertificateProvider instance configuration. Set to "google_cloud_private_spiffe" to use Certificate Authority Service certificate provider instance. }, "grpcEndpoint": { # Specification of the GRPC Endpoint. # gRPC specific configuration to access the gRPC server to obtain the cert and private key. - "targetUri": "A String", # Required. The target URI of the gRPC endpoint. Only UDS path is supported, and should start with “unix:”. + "targetUri": "A String", # Required. The target URI of the gRPC endpoint. Only UDS path is supported, and should start with "unix:". }, }, "createTime": "A String", # Output only. The timestamp when the resource was created. @@ -248,7 +248,7 @@

Method Details

"pluginInstance": "A String", # Required. Plugin instance name, used to locate and load CertificateProvider instance configuration. Set to "google_cloud_private_spiffe" to use Certificate Authority Service certificate provider instance. }, "grpcEndpoint": { # Specification of the GRPC Endpoint. # gRPC specific configuration to access the gRPC server to obtain the CA certificate. - "targetUri": "A String", # Required. The target URI of the gRPC endpoint. Only UDS path is supported, and should start with “unix:”. + "targetUri": "A String", # Required. The target URI of the gRPC endpoint. Only UDS path is supported, and should start with "unix:". }, }, ], @@ -329,7 +329,7 @@

Method Details

"pluginInstance": "A String", # Required. Plugin instance name, used to locate and load CertificateProvider instance configuration. Set to "google_cloud_private_spiffe" to use Certificate Authority Service certificate provider instance. }, "grpcEndpoint": { # Specification of the GRPC Endpoint. # gRPC specific configuration to access the gRPC server to obtain the cert and private key. - "targetUri": "A String", # Required. The target URI of the gRPC endpoint. Only UDS path is supported, and should start with “unix:”. + "targetUri": "A String", # Required. The target URI of the gRPC endpoint. Only UDS path is supported, and should start with "unix:". }, }, "createTime": "A String", # Output only. The timestamp when the resource was created. @@ -344,7 +344,7 @@

Method Details

"pluginInstance": "A String", # Required. Plugin instance name, used to locate and load CertificateProvider instance configuration. Set to "google_cloud_private_spiffe" to use Certificate Authority Service certificate provider instance. }, "grpcEndpoint": { # Specification of the GRPC Endpoint. # gRPC specific configuration to access the gRPC server to obtain the CA certificate. - "targetUri": "A String", # Required. The target URI of the gRPC endpoint. Only UDS path is supported, and should start with “unix:”. + "targetUri": "A String", # Required. The target URI of the gRPC endpoint. Only UDS path is supported, and should start with "unix:". }, }, ], @@ -385,7 +385,7 @@

Method Details

"pluginInstance": "A String", # Required. Plugin instance name, used to locate and load CertificateProvider instance configuration. Set to "google_cloud_private_spiffe" to use Certificate Authority Service certificate provider instance. }, "grpcEndpoint": { # Specification of the GRPC Endpoint. # gRPC specific configuration to access the gRPC server to obtain the cert and private key. - "targetUri": "A String", # Required. The target URI of the gRPC endpoint. Only UDS path is supported, and should start with “unix:”. + "targetUri": "A String", # Required. The target URI of the gRPC endpoint. Only UDS path is supported, and should start with "unix:". }, }, "createTime": "A String", # Output only. The timestamp when the resource was created. @@ -400,7 +400,7 @@

Method Details

"pluginInstance": "A String", # Required. Plugin instance name, used to locate and load CertificateProvider instance configuration. Set to "google_cloud_private_spiffe" to use Certificate Authority Service certificate provider instance. }, "grpcEndpoint": { # Specification of the GRPC Endpoint. # gRPC specific configuration to access the gRPC server to obtain the CA certificate. - "targetUri": "A String", # Required. The target URI of the gRPC endpoint. Only UDS path is supported, and should start with “unix:”. + "targetUri": "A String", # Required. The target URI of the gRPC endpoint. Only UDS path is supported, and should start with "unix:". }, }, ], diff --git a/docs/dyn/networksecurity_v1.projects.locations.serverTlsPolicies.html b/docs/dyn/networksecurity_v1.projects.locations.serverTlsPolicies.html index c193b031cb4..65a058695df 100644 --- a/docs/dyn/networksecurity_v1.projects.locations.serverTlsPolicies.html +++ b/docs/dyn/networksecurity_v1.projects.locations.serverTlsPolicies.html @@ -133,7 +133,7 @@

Method Details

"pluginInstance": "A String", # Required. Plugin instance name, used to locate and load CertificateProvider instance configuration. Set to "google_cloud_private_spiffe" to use Certificate Authority Service certificate provider instance. }, "grpcEndpoint": { # Specification of the GRPC Endpoint. # gRPC specific configuration to access the gRPC server to obtain the CA certificate. - "targetUri": "A String", # Required. The target URI of the gRPC endpoint. Only UDS path is supported, and should start with “unix:”. + "targetUri": "A String", # Required. The target URI of the gRPC endpoint. Only UDS path is supported, and should start with "unix:". }, }, ], @@ -144,7 +144,7 @@

Method Details

"pluginInstance": "A String", # Required. Plugin instance name, used to locate and load CertificateProvider instance configuration. Set to "google_cloud_private_spiffe" to use Certificate Authority Service certificate provider instance. }, "grpcEndpoint": { # Specification of the GRPC Endpoint. # gRPC specific configuration to access the gRPC server to obtain the cert and private key. - "targetUri": "A String", # Required. The target URI of the gRPC endpoint. Only UDS path is supported, and should start with “unix:”. + "targetUri": "A String", # Required. The target URI of the gRPC endpoint. Only UDS path is supported, and should start with "unix:". }, }, "updateTime": "A String", # Output only. The timestamp when the resource was updated. @@ -243,7 +243,7 @@

Method Details

"pluginInstance": "A String", # Required. Plugin instance name, used to locate and load CertificateProvider instance configuration. Set to "google_cloud_private_spiffe" to use Certificate Authority Service certificate provider instance. }, "grpcEndpoint": { # Specification of the GRPC Endpoint. # gRPC specific configuration to access the gRPC server to obtain the CA certificate. - "targetUri": "A String", # Required. The target URI of the gRPC endpoint. Only UDS path is supported, and should start with “unix:”. + "targetUri": "A String", # Required. The target URI of the gRPC endpoint. Only UDS path is supported, and should start with "unix:". }, }, ], @@ -254,7 +254,7 @@

Method Details

"pluginInstance": "A String", # Required. Plugin instance name, used to locate and load CertificateProvider instance configuration. Set to "google_cloud_private_spiffe" to use Certificate Authority Service certificate provider instance. }, "grpcEndpoint": { # Specification of the GRPC Endpoint. # gRPC specific configuration to access the gRPC server to obtain the cert and private key. - "targetUri": "A String", # Required. The target URI of the gRPC endpoint. Only UDS path is supported, and should start with “unix:”. + "targetUri": "A String", # Required. The target URI of the gRPC endpoint. Only UDS path is supported, and should start with "unix:". }, }, "updateTime": "A String", # Output only. The timestamp when the resource was updated. @@ -342,7 +342,7 @@

Method Details

"pluginInstance": "A String", # Required. Plugin instance name, used to locate and load CertificateProvider instance configuration. Set to "google_cloud_private_spiffe" to use Certificate Authority Service certificate provider instance. }, "grpcEndpoint": { # Specification of the GRPC Endpoint. # gRPC specific configuration to access the gRPC server to obtain the CA certificate. - "targetUri": "A String", # Required. The target URI of the gRPC endpoint. Only UDS path is supported, and should start with “unix:”. + "targetUri": "A String", # Required. The target URI of the gRPC endpoint. Only UDS path is supported, and should start with "unix:". }, }, ], @@ -353,7 +353,7 @@

Method Details

"pluginInstance": "A String", # Required. Plugin instance name, used to locate and load CertificateProvider instance configuration. Set to "google_cloud_private_spiffe" to use Certificate Authority Service certificate provider instance. }, "grpcEndpoint": { # Specification of the GRPC Endpoint. # gRPC specific configuration to access the gRPC server to obtain the cert and private key. - "targetUri": "A String", # Required. The target URI of the gRPC endpoint. Only UDS path is supported, and should start with “unix:”. + "targetUri": "A String", # Required. The target URI of the gRPC endpoint. Only UDS path is supported, and should start with "unix:". }, }, "updateTime": "A String", # Output only. The timestamp when the resource was updated. @@ -399,7 +399,7 @@

Method Details

"pluginInstance": "A String", # Required. Plugin instance name, used to locate and load CertificateProvider instance configuration. Set to "google_cloud_private_spiffe" to use Certificate Authority Service certificate provider instance. }, "grpcEndpoint": { # Specification of the GRPC Endpoint. # gRPC specific configuration to access the gRPC server to obtain the CA certificate. - "targetUri": "A String", # Required. The target URI of the gRPC endpoint. Only UDS path is supported, and should start with “unix:”. + "targetUri": "A String", # Required. The target URI of the gRPC endpoint. Only UDS path is supported, and should start with "unix:". }, }, ], @@ -410,7 +410,7 @@

Method Details

"pluginInstance": "A String", # Required. Plugin instance name, used to locate and load CertificateProvider instance configuration. Set to "google_cloud_private_spiffe" to use Certificate Authority Service certificate provider instance. }, "grpcEndpoint": { # Specification of the GRPC Endpoint. # gRPC specific configuration to access the gRPC server to obtain the cert and private key. - "targetUri": "A String", # Required. The target URI of the gRPC endpoint. Only UDS path is supported, and should start with “unix:”. + "targetUri": "A String", # Required. The target URI of the gRPC endpoint. Only UDS path is supported, and should start with "unix:". }, }, "updateTime": "A String", # Output only. The timestamp when the resource was updated. diff --git a/docs/dyn/networksecurity_v1beta1.projects.locations.authorizationPolicies.html b/docs/dyn/networksecurity_v1beta1.projects.locations.authorizationPolicies.html index 9749ac7c03e..9c83e5ebbdb 100644 --- a/docs/dyn/networksecurity_v1beta1.projects.locations.authorizationPolicies.html +++ b/docs/dyn/networksecurity_v1beta1.projects.locations.authorizationPolicies.html @@ -131,10 +131,10 @@

Method Details

{ # Specification of rules. "destinations": [ # Optional. List of attributes for the traffic destination. All of the destinations must match. A destination is a match if a request matches all the specified hosts, ports, methods and headers. If not set, the action specified in the 'action' field will be applied without any rule checks for the destination. { # Specification of traffic destination attributes. - "hosts": [ # Required. List of host names to match. Matched against the ":authority" header in http requests. At least one host should match. Each host can be an exact match, or a prefix match (example "mydomain.*") or a suffix match (example // *.myorg.com") or a presence(any) match "*". + "hosts": [ # Required. List of host names to match. Matched against the ":authority" header in http requests. At least one host should match. Each host can be an exact match, or a prefix match (example "mydomain.*") or a suffix match (example "*.myorg.com") or a presence (any) match "*". "A String", ], - "httpHeaderMatch": { # Specification of HTTP header match atrributes. # Optional. Match against key:value pair in http header. Provides a flexible match based on HTTP headers, for potentially advanced use cases. At least one header should match. Avoid using header matches to make authorization decisions unless there is a strong guarantee that requests arrive through a trusted client or proxy. + "httpHeaderMatch": { # Specification of HTTP header match attributes. # Optional. Match against key:value pair in http header. Provides a flexible match based on HTTP headers, for potentially advanced use cases. At least one header should match. Avoid using header matches to make authorization decisions unless there is a strong guarantee that requests arrive through a trusted client or proxy. "headerName": "A String", # Required. The name of the HTTP header to match. For matching against the HTTP request's authority, use a headerMatch with the header name ":authority". For matching a request's method, use the headerName ":method". "regexMatch": "A String", # Required. The value of the header must match the regular expression specified in regexMatch. For regular expression grammar, please see: en.cppreference.com/w/cpp/regex/ecmascript For matching against a port specified in the HTTP request, use a headerMatch with headerName set to Host and a regular expression that satisfies the RFC2616 Host header's port specifier. }, @@ -151,7 +151,7 @@

Method Details

"ipBlocks": [ # Optional. List of CIDR ranges to match based on source IP address. At least one IP block should match. Single IP (e.g., "1.2.3.4") and CIDR (e.g., "1.2.3.0/24") are supported. Authorization based on source IP alone should be avoided. The IP addresses of any load balancers or proxies should be considered untrusted. "A String", ], - "principals": [ # Optional. List of peer identities to match for authorization. At least one principal should match. Each peer can be an exact match, or a prefix match (example, "namespace/*") or a suffix match (example, // */service-account") or a presence match "*". Authorization based on the principal name without certificate validation (configured by ServerTlsPolicy resource) is considered insecure. + "principals": [ # Optional. List of peer identities to match for authorization. At least one principal should match. Each peer can be an exact match, or a prefix match (example, "namespace/*") or a suffix match (example, "*/service-account") or a presence match "*". Authorization based on the principal name without certificate validation (configured by ServerTlsPolicy resource) is considered insecure. "A String", ], }, @@ -252,10 +252,10 @@

Method Details

{ # Specification of rules. "destinations": [ # Optional. List of attributes for the traffic destination. All of the destinations must match. A destination is a match if a request matches all the specified hosts, ports, methods and headers. If not set, the action specified in the 'action' field will be applied without any rule checks for the destination. { # Specification of traffic destination attributes. - "hosts": [ # Required. List of host names to match. Matched against the ":authority" header in http requests. At least one host should match. Each host can be an exact match, or a prefix match (example "mydomain.*") or a suffix match (example // *.myorg.com") or a presence(any) match "*". + "hosts": [ # Required. List of host names to match. Matched against the ":authority" header in http requests. At least one host should match. Each host can be an exact match, or a prefix match (example "mydomain.*") or a suffix match (example "*.myorg.com") or a presence (any) match "*". "A String", ], - "httpHeaderMatch": { # Specification of HTTP header match atrributes. # Optional. Match against key:value pair in http header. Provides a flexible match based on HTTP headers, for potentially advanced use cases. At least one header should match. Avoid using header matches to make authorization decisions unless there is a strong guarantee that requests arrive through a trusted client or proxy. + "httpHeaderMatch": { # Specification of HTTP header match attributes. # Optional. Match against key:value pair in http header. Provides a flexible match based on HTTP headers, for potentially advanced use cases. At least one header should match. Avoid using header matches to make authorization decisions unless there is a strong guarantee that requests arrive through a trusted client or proxy. "headerName": "A String", # Required. The name of the HTTP header to match. For matching against the HTTP request's authority, use a headerMatch with the header name ":authority". For matching a request's method, use the headerName ":method". "regexMatch": "A String", # Required. The value of the header must match the regular expression specified in regexMatch. For regular expression grammar, please see: en.cppreference.com/w/cpp/regex/ecmascript For matching against a port specified in the HTTP request, use a headerMatch with headerName set to Host and a regular expression that satisfies the RFC2616 Host header's port specifier. }, @@ -272,7 +272,7 @@

Method Details

"ipBlocks": [ # Optional. List of CIDR ranges to match based on source IP address. At least one IP block should match. Single IP (e.g., "1.2.3.4") and CIDR (e.g., "1.2.3.0/24") are supported. Authorization based on source IP alone should be avoided. The IP addresses of any load balancers or proxies should be considered untrusted. "A String", ], - "principals": [ # Optional. List of peer identities to match for authorization. At least one principal should match. Each peer can be an exact match, or a prefix match (example, "namespace/*") or a suffix match (example, // */service-account") or a presence match "*". Authorization based on the principal name without certificate validation (configured by ServerTlsPolicy resource) is considered insecure. + "principals": [ # Optional. List of peer identities to match for authorization. At least one principal should match. Each peer can be an exact match, or a prefix match (example, "namespace/*") or a suffix match (example, "*/service-account") or a presence match "*". Authorization based on the principal name without certificate validation (configured by ServerTlsPolicy resource) is considered insecure. "A String", ], }, @@ -361,10 +361,10 @@

Method Details

{ # Specification of rules. "destinations": [ # Optional. List of attributes for the traffic destination. All of the destinations must match. A destination is a match if a request matches all the specified hosts, ports, methods and headers. If not set, the action specified in the 'action' field will be applied without any rule checks for the destination. { # Specification of traffic destination attributes. - "hosts": [ # Required. List of host names to match. Matched against the ":authority" header in http requests. At least one host should match. Each host can be an exact match, or a prefix match (example "mydomain.*") or a suffix match (example // *.myorg.com") or a presence(any) match "*". + "hosts": [ # Required. List of host names to match. Matched against the ":authority" header in http requests. At least one host should match. Each host can be an exact match, or a prefix match (example "mydomain.*") or a suffix match (example "*.myorg.com") or a presence (any) match "*". "A String", ], - "httpHeaderMatch": { # Specification of HTTP header match atrributes. # Optional. Match against key:value pair in http header. Provides a flexible match based on HTTP headers, for potentially advanced use cases. At least one header should match. Avoid using header matches to make authorization decisions unless there is a strong guarantee that requests arrive through a trusted client or proxy. + "httpHeaderMatch": { # Specification of HTTP header match attributes. # Optional. Match against key:value pair in http header. Provides a flexible match based on HTTP headers, for potentially advanced use cases. At least one header should match. Avoid using header matches to make authorization decisions unless there is a strong guarantee that requests arrive through a trusted client or proxy. "headerName": "A String", # Required. The name of the HTTP header to match. For matching against the HTTP request's authority, use a headerMatch with the header name ":authority". For matching a request's method, use the headerName ":method". "regexMatch": "A String", # Required. The value of the header must match the regular expression specified in regexMatch. For regular expression grammar, please see: en.cppreference.com/w/cpp/regex/ecmascript For matching against a port specified in the HTTP request, use a headerMatch with headerName set to Host and a regular expression that satisfies the RFC2616 Host header's port specifier. }, @@ -381,7 +381,7 @@

Method Details

"ipBlocks": [ # Optional. List of CIDR ranges to match based on source IP address. At least one IP block should match. Single IP (e.g., "1.2.3.4") and CIDR (e.g., "1.2.3.0/24") are supported. Authorization based on source IP alone should be avoided. The IP addresses of any load balancers or proxies should be considered untrusted. "A String", ], - "principals": [ # Optional. List of peer identities to match for authorization. At least one principal should match. Each peer can be an exact match, or a prefix match (example, "namespace/*") or a suffix match (example, // */service-account") or a presence match "*". Authorization based on the principal name without certificate validation (configured by ServerTlsPolicy resource) is considered insecure. + "principals": [ # Optional. List of peer identities to match for authorization. At least one principal should match. Each peer can be an exact match, or a prefix match (example, "namespace/*") or a suffix match (example, "*/service-account") or a presence match "*". Authorization based on the principal name without certificate validation (configured by ServerTlsPolicy resource) is considered insecure. "A String", ], }, @@ -430,10 +430,10 @@

Method Details

{ # Specification of rules. "destinations": [ # Optional. List of attributes for the traffic destination. All of the destinations must match. A destination is a match if a request matches all the specified hosts, ports, methods and headers. If not set, the action specified in the 'action' field will be applied without any rule checks for the destination. { # Specification of traffic destination attributes. - "hosts": [ # Required. List of host names to match. Matched against the ":authority" header in http requests. At least one host should match. Each host can be an exact match, or a prefix match (example "mydomain.*") or a suffix match (example // *.myorg.com") or a presence(any) match "*". + "hosts": [ # Required. List of host names to match. Matched against the ":authority" header in http requests. At least one host should match. Each host can be an exact match, or a prefix match (example "mydomain.*") or a suffix match (example "*.myorg.com") or a presence (any) match "*". "A String", ], - "httpHeaderMatch": { # Specification of HTTP header match atrributes. # Optional. Match against key:value pair in http header. Provides a flexible match based on HTTP headers, for potentially advanced use cases. At least one header should match. Avoid using header matches to make authorization decisions unless there is a strong guarantee that requests arrive through a trusted client or proxy. + "httpHeaderMatch": { # Specification of HTTP header match attributes. # Optional. Match against key:value pair in http header. Provides a flexible match based on HTTP headers, for potentially advanced use cases. At least one header should match. Avoid using header matches to make authorization decisions unless there is a strong guarantee that requests arrive through a trusted client or proxy. "headerName": "A String", # Required. The name of the HTTP header to match. For matching against the HTTP request's authority, use a headerMatch with the header name ":authority". For matching a request's method, use the headerName ":method". "regexMatch": "A String", # Required. The value of the header must match the regular expression specified in regexMatch. For regular expression grammar, please see: en.cppreference.com/w/cpp/regex/ecmascript For matching against a port specified in the HTTP request, use a headerMatch with headerName set to Host and a regular expression that satisfies the RFC2616 Host header's port specifier. }, @@ -450,7 +450,7 @@

Method Details

"ipBlocks": [ # Optional. List of CIDR ranges to match based on source IP address. At least one IP block should match. Single IP (e.g., "1.2.3.4") and CIDR (e.g., "1.2.3.0/24") are supported. Authorization based on source IP alone should be avoided. The IP addresses of any load balancers or proxies should be considered untrusted. "A String", ], - "principals": [ # Optional. List of peer identities to match for authorization. At least one principal should match. Each peer can be an exact match, or a prefix match (example, "namespace/*") or a suffix match (example, // */service-account") or a presence match "*". Authorization based on the principal name without certificate validation (configured by ServerTlsPolicy resource) is considered insecure. + "principals": [ # Optional. List of peer identities to match for authorization. At least one principal should match. Each peer can be an exact match, or a prefix match (example, "namespace/*") or a suffix match (example, "*/service-account") or a presence match "*". Authorization based on the principal name without certificate validation (configured by ServerTlsPolicy resource) is considered insecure. "A String", ], }, diff --git a/docs/dyn/networksecurity_v1beta1.projects.locations.clientTlsPolicies.html b/docs/dyn/networksecurity_v1beta1.projects.locations.clientTlsPolicies.html index a456fa536d2..59a28082685 100644 --- a/docs/dyn/networksecurity_v1beta1.projects.locations.clientTlsPolicies.html +++ b/docs/dyn/networksecurity_v1beta1.projects.locations.clientTlsPolicies.html @@ -125,7 +125,7 @@

Method Details

"pluginInstance": "A String", # Required. Plugin instance name, used to locate and load CertificateProvider instance configuration. Set to "google_cloud_private_spiffe" to use Certificate Authority Service certificate provider instance. }, "grpcEndpoint": { # Specification of the GRPC Endpoint. # gRPC specific configuration to access the gRPC server to obtain the cert and private key. - "targetUri": "A String", # Required. The target URI of the gRPC endpoint. Only UDS path is supported, and should start with “unix:”. + "targetUri": "A String", # Required. The target URI of the gRPC endpoint. Only UDS path is supported, and should start with "unix:". }, }, "createTime": "A String", # Output only. The timestamp when the resource was created. @@ -140,7 +140,7 @@

Method Details

"pluginInstance": "A String", # Required. Plugin instance name, used to locate and load CertificateProvider instance configuration. Set to "google_cloud_private_spiffe" to use Certificate Authority Service certificate provider instance. }, "grpcEndpoint": { # Specification of the GRPC Endpoint. # gRPC specific configuration to access the gRPC server to obtain the CA certificate. - "targetUri": "A String", # Required. The target URI of the gRPC endpoint. Only UDS path is supported, and should start with “unix:”. + "targetUri": "A String", # Required. The target URI of the gRPC endpoint. Only UDS path is supported, and should start with "unix:". }, }, ], @@ -233,7 +233,7 @@

Method Details

"pluginInstance": "A String", # Required. Plugin instance name, used to locate and load CertificateProvider instance configuration. Set to "google_cloud_private_spiffe" to use Certificate Authority Service certificate provider instance. }, "grpcEndpoint": { # Specification of the GRPC Endpoint. # gRPC specific configuration to access the gRPC server to obtain the cert and private key. - "targetUri": "A String", # Required. The target URI of the gRPC endpoint. Only UDS path is supported, and should start with “unix:”. + "targetUri": "A String", # Required. The target URI of the gRPC endpoint. Only UDS path is supported, and should start with "unix:". }, }, "createTime": "A String", # Output only. The timestamp when the resource was created. @@ -248,7 +248,7 @@

Method Details

"pluginInstance": "A String", # Required. Plugin instance name, used to locate and load CertificateProvider instance configuration. Set to "google_cloud_private_spiffe" to use Certificate Authority Service certificate provider instance. }, "grpcEndpoint": { # Specification of the GRPC Endpoint. # gRPC specific configuration to access the gRPC server to obtain the CA certificate. - "targetUri": "A String", # Required. The target URI of the gRPC endpoint. Only UDS path is supported, and should start with “unix:”. + "targetUri": "A String", # Required. The target URI of the gRPC endpoint. Only UDS path is supported, and should start with "unix:". }, }, ], @@ -329,7 +329,7 @@

Method Details

"pluginInstance": "A String", # Required. Plugin instance name, used to locate and load CertificateProvider instance configuration. Set to "google_cloud_private_spiffe" to use Certificate Authority Service certificate provider instance. }, "grpcEndpoint": { # Specification of the GRPC Endpoint. # gRPC specific configuration to access the gRPC server to obtain the cert and private key. - "targetUri": "A String", # Required. The target URI of the gRPC endpoint. Only UDS path is supported, and should start with “unix:”. + "targetUri": "A String", # Required. The target URI of the gRPC endpoint. Only UDS path is supported, and should start with "unix:". }, }, "createTime": "A String", # Output only. The timestamp when the resource was created. @@ -344,7 +344,7 @@

Method Details

"pluginInstance": "A String", # Required. Plugin instance name, used to locate and load CertificateProvider instance configuration. Set to "google_cloud_private_spiffe" to use Certificate Authority Service certificate provider instance. }, "grpcEndpoint": { # Specification of the GRPC Endpoint. # gRPC specific configuration to access the gRPC server to obtain the CA certificate. - "targetUri": "A String", # Required. The target URI of the gRPC endpoint. Only UDS path is supported, and should start with “unix:”. + "targetUri": "A String", # Required. The target URI of the gRPC endpoint. Only UDS path is supported, and should start with "unix:". }, }, ], @@ -385,7 +385,7 @@

Method Details

"pluginInstance": "A String", # Required. Plugin instance name, used to locate and load CertificateProvider instance configuration. Set to "google_cloud_private_spiffe" to use Certificate Authority Service certificate provider instance. }, "grpcEndpoint": { # Specification of the GRPC Endpoint. # gRPC specific configuration to access the gRPC server to obtain the cert and private key. - "targetUri": "A String", # Required. The target URI of the gRPC endpoint. Only UDS path is supported, and should start with “unix:”. + "targetUri": "A String", # Required. The target URI of the gRPC endpoint. Only UDS path is supported, and should start with "unix:". }, }, "createTime": "A String", # Output only. The timestamp when the resource was created. @@ -400,7 +400,7 @@

Method Details

"pluginInstance": "A String", # Required. Plugin instance name, used to locate and load CertificateProvider instance configuration. Set to "google_cloud_private_spiffe" to use Certificate Authority Service certificate provider instance. }, "grpcEndpoint": { # Specification of the GRPC Endpoint. # gRPC specific configuration to access the gRPC server to obtain the CA certificate. - "targetUri": "A String", # Required. The target URI of the gRPC endpoint. Only UDS path is supported, and should start with “unix:”. + "targetUri": "A String", # Required. The target URI of the gRPC endpoint. Only UDS path is supported, and should start with "unix:". }, }, ], diff --git a/docs/dyn/networksecurity_v1beta1.projects.locations.serverTlsPolicies.html b/docs/dyn/networksecurity_v1beta1.projects.locations.serverTlsPolicies.html index a7cc7a5f17a..7d2f15989b9 100644 --- a/docs/dyn/networksecurity_v1beta1.projects.locations.serverTlsPolicies.html +++ b/docs/dyn/networksecurity_v1beta1.projects.locations.serverTlsPolicies.html @@ -133,7 +133,7 @@

Method Details

"pluginInstance": "A String", # Required. Plugin instance name, used to locate and load CertificateProvider instance configuration. Set to "google_cloud_private_spiffe" to use Certificate Authority Service certificate provider instance. }, "grpcEndpoint": { # Specification of the GRPC Endpoint. # gRPC specific configuration to access the gRPC server to obtain the CA certificate. - "targetUri": "A String", # Required. The target URI of the gRPC endpoint. Only UDS path is supported, and should start with “unix:”. + "targetUri": "A String", # Required. The target URI of the gRPC endpoint. Only UDS path is supported, and should start with "unix:". }, }, ], @@ -144,7 +144,7 @@

Method Details

"pluginInstance": "A String", # Required. Plugin instance name, used to locate and load CertificateProvider instance configuration. Set to "google_cloud_private_spiffe" to use Certificate Authority Service certificate provider instance. }, "grpcEndpoint": { # Specification of the GRPC Endpoint. # gRPC specific configuration to access the gRPC server to obtain the cert and private key. - "targetUri": "A String", # Required. The target URI of the gRPC endpoint. Only UDS path is supported, and should start with “unix:”. + "targetUri": "A String", # Required. The target URI of the gRPC endpoint. Only UDS path is supported, and should start with "unix:". }, }, "updateTime": "A String", # Output only. The timestamp when the resource was updated. @@ -243,7 +243,7 @@

Method Details

"pluginInstance": "A String", # Required. Plugin instance name, used to locate and load CertificateProvider instance configuration. Set to "google_cloud_private_spiffe" to use Certificate Authority Service certificate provider instance. }, "grpcEndpoint": { # Specification of the GRPC Endpoint. # gRPC specific configuration to access the gRPC server to obtain the CA certificate. - "targetUri": "A String", # Required. The target URI of the gRPC endpoint. Only UDS path is supported, and should start with “unix:”. + "targetUri": "A String", # Required. The target URI of the gRPC endpoint. Only UDS path is supported, and should start with "unix:". }, }, ], @@ -254,7 +254,7 @@

Method Details

"pluginInstance": "A String", # Required. Plugin instance name, used to locate and load CertificateProvider instance configuration. Set to "google_cloud_private_spiffe" to use Certificate Authority Service certificate provider instance. }, "grpcEndpoint": { # Specification of the GRPC Endpoint. # gRPC specific configuration to access the gRPC server to obtain the cert and private key. - "targetUri": "A String", # Required. The target URI of the gRPC endpoint. Only UDS path is supported, and should start with “unix:”. + "targetUri": "A String", # Required. The target URI of the gRPC endpoint. Only UDS path is supported, and should start with "unix:". }, }, "updateTime": "A String", # Output only. The timestamp when the resource was updated. @@ -342,7 +342,7 @@

Method Details

"pluginInstance": "A String", # Required. Plugin instance name, used to locate and load CertificateProvider instance configuration. Set to "google_cloud_private_spiffe" to use Certificate Authority Service certificate provider instance. }, "grpcEndpoint": { # Specification of the GRPC Endpoint. # gRPC specific configuration to access the gRPC server to obtain the CA certificate. - "targetUri": "A String", # Required. The target URI of the gRPC endpoint. Only UDS path is supported, and should start with “unix:”. + "targetUri": "A String", # Required. The target URI of the gRPC endpoint. Only UDS path is supported, and should start with "unix:". }, }, ], @@ -353,7 +353,7 @@

Method Details

"pluginInstance": "A String", # Required. Plugin instance name, used to locate and load CertificateProvider instance configuration. Set to "google_cloud_private_spiffe" to use Certificate Authority Service certificate provider instance. }, "grpcEndpoint": { # Specification of the GRPC Endpoint. # gRPC specific configuration to access the gRPC server to obtain the cert and private key. - "targetUri": "A String", # Required. The target URI of the gRPC endpoint. Only UDS path is supported, and should start with “unix:”. + "targetUri": "A String", # Required. The target URI of the gRPC endpoint. Only UDS path is supported, and should start with "unix:". }, }, "updateTime": "A String", # Output only. The timestamp when the resource was updated. @@ -399,7 +399,7 @@

Method Details

"pluginInstance": "A String", # Required. Plugin instance name, used to locate and load CertificateProvider instance configuration. Set to "google_cloud_private_spiffe" to use Certificate Authority Service certificate provider instance. }, "grpcEndpoint": { # Specification of the GRPC Endpoint. # gRPC specific configuration to access the gRPC server to obtain the CA certificate. - "targetUri": "A String", # Required. The target URI of the gRPC endpoint. Only UDS path is supported, and should start with “unix:”. + "targetUri": "A String", # Required. The target URI of the gRPC endpoint. Only UDS path is supported, and should start with "unix:". }, }, ], @@ -410,7 +410,7 @@

Method Details

"pluginInstance": "A String", # Required. Plugin instance name, used to locate and load CertificateProvider instance configuration. Set to "google_cloud_private_spiffe" to use Certificate Authority Service certificate provider instance. }, "grpcEndpoint": { # Specification of the GRPC Endpoint. # gRPC specific configuration to access the gRPC server to obtain the cert and private key. - "targetUri": "A String", # Required. The target URI of the gRPC endpoint. Only UDS path is supported, and should start with “unix:”. + "targetUri": "A String", # Required. The target URI of the gRPC endpoint. Only UDS path is supported, and should start with "unix:". }, }, "updateTime": "A String", # Output only. The timestamp when the resource was updated. diff --git a/docs/dyn/webrisk_v1.hashes.html b/docs/dyn/webrisk_v1.hashes.html index 8eb9896528e..8481eace7b4 100644 --- a/docs/dyn/webrisk_v1.hashes.html +++ b/docs/dyn/webrisk_v1.hashes.html @@ -98,7 +98,7 @@

Method Details

MALWARE - Malware targeting any platform. SOCIAL_ENGINEERING - Social engineering targeting any platform. UNWANTED_SOFTWARE - Unwanted software targeting any platform. - HIGH_RECALL - High Recall Social Engineering list targeting any platform. + SOCIAL_ENGINEERING_EXTENDED_COVERAGE - Extended Coverage Social Engineering list targeting any platform. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/webrisk_v1.threatLists.html b/docs/dyn/webrisk_v1.threatLists.html index a24c9db714a..da3d2ab9cda 100644 --- a/docs/dyn/webrisk_v1.threatLists.html +++ b/docs/dyn/webrisk_v1.threatLists.html @@ -104,7 +104,7 @@

Method Details

MALWARE - Malware targeting any platform. SOCIAL_ENGINEERING - Social engineering targeting any platform. UNWANTED_SOFTWARE - Unwanted software targeting any platform. - HIGH_RECALL - High Recall Social Engineering list targeting any platform. + SOCIAL_ENGINEERING_EXTENDED_COVERAGE - Extended Coverage Social Engineering list targeting any platform. versionToken: string, The current version token of the client for the requested list (the client version that was received from the last successful diff). If the client does not have a version token (this is the first time calling ComputeThreatListDiff), this may be left empty and a full database snapshot will be returned. x__xgafv: string, V1 error format. Allowed values diff --git a/docs/dyn/webrisk_v1.uris.html b/docs/dyn/webrisk_v1.uris.html index a7d2c057885..2f8df136cfa 100644 --- a/docs/dyn/webrisk_v1.uris.html +++ b/docs/dyn/webrisk_v1.uris.html @@ -97,7 +97,7 @@

Method Details

MALWARE - Malware targeting any platform. SOCIAL_ENGINEERING - Social engineering targeting any platform. UNWANTED_SOFTWARE - Unwanted software targeting any platform. - HIGH_RECALL - High Recall Social Engineering list targeting any platform. + SOCIAL_ENGINEERING_EXTENDED_COVERAGE - Extended Coverage Social Engineering list targeting any platform. uri: string, Required. The URI to be checked for matches. x__xgafv: string, V1 error format. Allowed values diff --git a/googleapiclient/discovery_cache/documents/acceleratedmobilepageurl.v1.json b/googleapiclient/discovery_cache/documents/acceleratedmobilepageurl.v1.json index 496c5d14d20..9bc6a2c74f7 100644 --- a/googleapiclient/discovery_cache/documents/acceleratedmobilepageurl.v1.json +++ b/googleapiclient/discovery_cache/documents/acceleratedmobilepageurl.v1.json @@ -115,7 +115,7 @@ } } }, - "revision": "20220708", + "revision": "20220716", "rootUrl": "https://acceleratedmobilepageurl.googleapis.com/", "schemas": { "AmpUrl": { diff --git a/googleapiclient/discovery_cache/documents/accessapproval.v1.json b/googleapiclient/discovery_cache/documents/accessapproval.v1.json index 5244e550350..eff6731a922 100644 --- a/googleapiclient/discovery_cache/documents/accessapproval.v1.json +++ b/googleapiclient/discovery_cache/documents/accessapproval.v1.json @@ -913,7 +913,7 @@ } } }, - "revision": "20220701", + "revision": "20220714", "rootUrl": "https://accessapproval.googleapis.com/", "schemas": { "AccessApprovalServiceAccount": { diff --git a/googleapiclient/discovery_cache/documents/accesscontextmanager.v1.json b/googleapiclient/discovery_cache/documents/accesscontextmanager.v1.json index 675398289de..78d7faab920 100644 --- a/googleapiclient/discovery_cache/documents/accesscontextmanager.v1.json +++ b/googleapiclient/discovery_cache/documents/accesscontextmanager.v1.json @@ -1083,7 +1083,7 @@ } } }, - "revision": "20220708", + "revision": "20220715", "rootUrl": "https://accesscontextmanager.googleapis.com/", "schemas": { "AccessContextManagerOperationMetadata": { diff --git a/googleapiclient/discovery_cache/documents/accesscontextmanager.v1beta.json b/googleapiclient/discovery_cache/documents/accesscontextmanager.v1beta.json index c0ffe03490a..b26a262f724 100644 --- a/googleapiclient/discovery_cache/documents/accesscontextmanager.v1beta.json +++ b/googleapiclient/discovery_cache/documents/accesscontextmanager.v1beta.json @@ -609,7 +609,7 @@ } } }, - "revision": "20220708", + "revision": "20220715", "rootUrl": "https://accesscontextmanager.googleapis.com/", "schemas": { "AccessContextManagerOperationMetadata": { diff --git a/googleapiclient/discovery_cache/documents/adexchangebuyer2.v2beta1.json b/googleapiclient/discovery_cache/documents/adexchangebuyer2.v2beta1.json index 447dbcaf57f..4aa38601b0c 100644 --- a/googleapiclient/discovery_cache/documents/adexchangebuyer2.v2beta1.json +++ b/googleapiclient/discovery_cache/documents/adexchangebuyer2.v2beta1.json @@ -2568,7 +2568,7 @@ } } }, - "revision": "20220709", + "revision": "20220718", "rootUrl": "https://adexchangebuyer.googleapis.com/", "schemas": { "AbsoluteDateRange": { diff --git a/googleapiclient/discovery_cache/documents/admin.datatransfer_v1.json b/googleapiclient/discovery_cache/documents/admin.datatransfer_v1.json index 45c4bd54da7..74ec5fc6500 100644 --- a/googleapiclient/discovery_cache/documents/admin.datatransfer_v1.json +++ b/googleapiclient/discovery_cache/documents/admin.datatransfer_v1.json @@ -272,7 +272,7 @@ } } }, - "revision": "20220705", + "revision": "20220712", "rootUrl": "https://admin.googleapis.com/", "schemas": { "Application": { diff --git a/googleapiclient/discovery_cache/documents/admin.directory_v1.json b/googleapiclient/discovery_cache/documents/admin.directory_v1.json index 197b039cf2b..6efb51d20c1 100644 --- a/googleapiclient/discovery_cache/documents/admin.directory_v1.json +++ b/googleapiclient/discovery_cache/documents/admin.directory_v1.json @@ -4407,7 +4407,7 @@ } } }, - "revision": "20220705", + "revision": "20220712", "rootUrl": "https://admin.googleapis.com/", "schemas": { "Alias": { diff --git a/googleapiclient/discovery_cache/documents/admin.reports_v1.json b/googleapiclient/discovery_cache/documents/admin.reports_v1.json index 4c74d379fbc..57e9607711e 100644 --- a/googleapiclient/discovery_cache/documents/admin.reports_v1.json +++ b/googleapiclient/discovery_cache/documents/admin.reports_v1.json @@ -623,7 +623,7 @@ } } }, - "revision": "20220705", + "revision": "20220712", "rootUrl": "https://admin.googleapis.com/", "schemas": { "Activities": { diff --git a/googleapiclient/discovery_cache/documents/admob.v1.json b/googleapiclient/discovery_cache/documents/admob.v1.json index 89dd1a38960..5c88e8fd654 100644 --- a/googleapiclient/discovery_cache/documents/admob.v1.json +++ b/googleapiclient/discovery_cache/documents/admob.v1.json @@ -321,7 +321,7 @@ } } }, - "revision": "20220708", + "revision": "20220716", "rootUrl": "https://admob.googleapis.com/", "schemas": { "AdUnit": { diff --git a/googleapiclient/discovery_cache/documents/admob.v1beta.json b/googleapiclient/discovery_cache/documents/admob.v1beta.json index 08fb37b9ae4..2496f59954e 100644 --- a/googleapiclient/discovery_cache/documents/admob.v1beta.json +++ b/googleapiclient/discovery_cache/documents/admob.v1beta.json @@ -359,7 +359,7 @@ } } }, - "revision": "20220708", + "revision": "20220716", "rootUrl": "https://admob.googleapis.com/", "schemas": { "AdSource": { diff --git a/googleapiclient/discovery_cache/documents/adsense.v2.json b/googleapiclient/discovery_cache/documents/adsense.v2.json index 45594b5c2a4..0f86262e781 100644 --- a/googleapiclient/discovery_cache/documents/adsense.v2.json +++ b/googleapiclient/discovery_cache/documents/adsense.v2.json @@ -1645,7 +1645,7 @@ } } }, - "revision": "20220708", + "revision": "20220716", "rootUrl": "https://adsense.googleapis.com/", "schemas": { "Account": { diff --git a/googleapiclient/discovery_cache/documents/alertcenter.v1beta1.json b/googleapiclient/discovery_cache/documents/alertcenter.v1beta1.json index 4856806181e..25737f03885 100644 --- a/googleapiclient/discovery_cache/documents/alertcenter.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/alertcenter.v1beta1.json @@ -423,7 +423,7 @@ } } }, - "revision": "20220704", + "revision": "20220711", "rootUrl": "https://alertcenter.googleapis.com/", "schemas": { "AccountSuspensionDetails": { diff --git a/googleapiclient/discovery_cache/documents/analyticsadmin.v1alpha.json b/googleapiclient/discovery_cache/documents/analyticsadmin.v1alpha.json index a87b1f9e8f1..1937cd2c047 100644 --- a/googleapiclient/discovery_cache/documents/analyticsadmin.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/analyticsadmin.v1alpha.json @@ -2616,7 +2616,7 @@ } } }, - "revision": "20220708", + "revision": "20220711", "rootUrl": "https://analyticsadmin.googleapis.com/", "schemas": { "GoogleAnalyticsAdminV1alphaAccount": { diff --git a/googleapiclient/discovery_cache/documents/analyticsdata.v1beta.json b/googleapiclient/discovery_cache/documents/analyticsdata.v1beta.json index 7f0b145c2d7..2e577bb5992 100644 --- a/googleapiclient/discovery_cache/documents/analyticsdata.v1beta.json +++ b/googleapiclient/discovery_cache/documents/analyticsdata.v1beta.json @@ -313,7 +313,7 @@ } } }, - "revision": "20220708", + "revision": "20220716", "rootUrl": "https://analyticsdata.googleapis.com/", "schemas": { "ActiveMetricRestriction": { diff --git a/googleapiclient/discovery_cache/documents/analyticshub.v1beta1.json b/googleapiclient/discovery_cache/documents/analyticshub.v1beta1.json index a3f5fc5c6db..e87c31cf533 100644 --- a/googleapiclient/discovery_cache/documents/analyticshub.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/analyticshub.v1beta1.json @@ -765,7 +765,7 @@ } } }, - "revision": "20220701", + "revision": "20220708", "rootUrl": "https://analyticshub.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/googleapiclient/discovery_cache/documents/androiddeviceprovisioning.v1.json b/googleapiclient/discovery_cache/documents/androiddeviceprovisioning.v1.json index 95adba95e36..139d530aedc 100644 --- a/googleapiclient/discovery_cache/documents/androiddeviceprovisioning.v1.json +++ b/googleapiclient/discovery_cache/documents/androiddeviceprovisioning.v1.json @@ -825,7 +825,7 @@ } } }, - "revision": "20220708", + "revision": "20220715", "rootUrl": "https://androiddeviceprovisioning.googleapis.com/", "schemas": { "ClaimDeviceRequest": { diff --git a/googleapiclient/discovery_cache/documents/androidenterprise.v1.json b/googleapiclient/discovery_cache/documents/androidenterprise.v1.json index 786b95a7e65..580d956b900 100644 --- a/googleapiclient/discovery_cache/documents/androidenterprise.v1.json +++ b/googleapiclient/discovery_cache/documents/androidenterprise.v1.json @@ -2610,7 +2610,7 @@ } } }, - "revision": "20220703", + "revision": "20220714", "rootUrl": "https://androidenterprise.googleapis.com/", "schemas": { "Administrator": { diff --git a/googleapiclient/discovery_cache/documents/androidmanagement.v1.json b/googleapiclient/discovery_cache/documents/androidmanagement.v1.json index b57f9a23710..aa96e30ea20 100644 --- a/googleapiclient/discovery_cache/documents/androidmanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/androidmanagement.v1.json @@ -1065,7 +1065,7 @@ } } }, - "revision": "20220613", + "revision": "20220704", "rootUrl": "https://androidmanagement.googleapis.com/", "schemas": { "AdbShellCommandEvent": { @@ -1193,7 +1193,7 @@ "type": "string" }, "packageNames": { - "description": "Package names of all packages that are associated with the particular user id. In most cases, this will be a single package name, the package that has been assigned that user id. If multiple application share a uid then all packages sharing uid will be included.", + "description": "Package names of all packages that are associated with the particular user ID. In most cases, this will be a single package name, the package that has been assigned that user ID. If multiple application share a UID then all packages sharing UID will be included.", "items": { "type": "string" }, @@ -1583,7 +1583,9 @@ "BLOCK_UNINSTALL", "PERMISSION_GRANT", "PACKAGE_ACCESS", - "ENABLE_SYSTEM_APP" + "ENABLE_SYSTEM_APP", + "NETWORK_ACTIVITY_LOGS", + "SECURITY_LOGS" ], "enumDescriptions": [ "No delegation scope specified.", @@ -1592,7 +1594,9 @@ "Grants access to blocking uninstallation.", "Grants access to permission policy and permission grant state.", "Grants access to package access state.", - "Grants access for enabling system apps." + "Grants access for enabling system apps.", + "Grants access to network activity logs. Allows the delegated application to call setNetworkLoggingEnabled (https://developer.android.com/reference/android/app/admin/DevicePolicyManager#setNetworkLoggingEnabled%28android.content.ComponentName,%20boolean%29), isNetworkLoggingEnabled (https://developer.android.com/reference/android/app/admin/DevicePolicyManager#isNetworkLoggingEnabled%28android.content.ComponentName%29) and retrieveNetworkLogs (https://developer.android.com/reference/android/app/admin/DevicePolicyManager#retrieveNetworkLogs%28android.content.ComponentName,%20long%29) methods. This scope can be delegated to at most one application. Supported for fully managed devices on Android 10 and above. Supported for a work profile on Android 12 and above. When delegation is supported and set, NETWORK_ACTIVITY_LOGS is ignored.", + "Grants access to security logs. Allows the delegated application to call setSecurityLoggingEnabled (https://developer.android.com/reference/android/app/admin/DevicePolicyManager#setSecurityLoggingEnabled%28android.content.ComponentName,%20boolean%29), isSecurityLoggingEnabled (https://developer.android.com/reference/android/app/admin/DevicePolicyManager#isSecurityLoggingEnabled%28android.content.ComponentName%29), retrieveSecurityLogs (https://developer.android.com/reference/android/app/admin/DevicePolicyManager#retrieveSecurityLogs%28android.content.ComponentName%29) and retrievePreRebootSecurityLogs (https://developer.android.com/reference/android/app/admin/DevicePolicyManager#retrievePreRebootSecurityLogs%28android.content.ComponentName%29) methods. This scope can be delegated to at most one application. Supported for fully managed devices and company-owned devices with a work profile on Android 12 and above. When delegation is supported and set, SECURITY_LOGS is ignored." ], "type": "string" }, @@ -2603,7 +2607,7 @@ "type": "string" }, "duration": { - "description": "The length of time the enrollment token is valid, ranging from 1 minute to 90 days. If not specified, the default duration is 1 hour.", + "description": "The length of time the enrollment token is valid, ranging from 1 minute to Durations.MAX_VALUE (https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/util/Durations.html#MAX_VALUE), approximately 10,000 years. If not specified, the default duration is 1 hour. Please note that if requested duration causes the resulting expiration_timestamp to exceed Timestamps.MAX_VALUE (https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/util/Timestamps.html#MAX_VALUE), then expiration_timestamp is coerced to Timestamps.MAX_VALUE.", "format": "google-duration", "type": "string" }, @@ -5158,8 +5162,8 @@ ], "enumDescriptions": [ "This value is not used.", - "Enable logging of on-device security events, like when the device password is incorrectly entered or removable storage is mounted. See UsageLogEvent for a complete description of the logged security events. Supported for fully managed devices on Android 7 and above. Supported for company-owned devices with a work profile on Android 12 and above, on which only security events from the work profile are logged.", - "Enable logging of on-device network events, like DNS lookups and TCP connections. See UsageLogEvent for a complete description of the logged network events. Supported for fully managed devices on Android 8 and above. Supported for company-owned devices with a work profile on Android 12 and above, on which only network events from the work profile are logged." + "Enable logging of on-device security events, like when the device password is incorrectly entered or removable storage is mounted. See UsageLogEvent for a complete description of the logged security events. Supported for fully managed devices on Android 7 and above. Supported for company-owned devices with a work profile on Android 12 and above, on which only security events from the work profile are logged. Can be overridden by the application delegated scope SECURITY_LOGS", + "Enable logging of on-device network events, like DNS lookups and TCP connections. See UsageLogEvent for a complete description of the logged network events. Supported for fully managed devices on Android 8 and above. Supported for company-owned devices with a work profile on Android 12 and above, on which only network events from the work profile are logged. Can be overridden by the application delegated scope NETWORK_ACTIVITY_LOGS" ], "type": "string" }, @@ -5175,8 +5179,8 @@ ], "enumDescriptions": [ "This value is not used.", - "Enable logging of on-device security events, like when the device password is incorrectly entered or removable storage is mounted. See UsageLogEvent for a complete description of the logged security events. Supported for fully managed devices on Android 7 and above. Supported for company-owned devices with a work profile on Android 12 and above, on which only security events from the work profile are logged.", - "Enable logging of on-device network events, like DNS lookups and TCP connections. See UsageLogEvent for a complete description of the logged network events. Supported for fully managed devices on Android 8 and above. Supported for company-owned devices with a work profile on Android 12 and above, on which only network events from the work profile are logged." + "Enable logging of on-device security events, like when the device password is incorrectly entered or removable storage is mounted. See UsageLogEvent for a complete description of the logged security events. Supported for fully managed devices on Android 7 and above. Supported for company-owned devices with a work profile on Android 12 and above, on which only security events from the work profile are logged. Can be overridden by the application delegated scope SECURITY_LOGS", + "Enable logging of on-device network events, like DNS lookups and TCP connections. See UsageLogEvent for a complete description of the logged network events. Supported for fully managed devices on Android 8 and above. Supported for company-owned devices with a work profile on Android 12 and above, on which only network events from the work profile are logged. Can be overridden by the application delegated scope NETWORK_ACTIVITY_LOGS" ], "type": "string" }, @@ -5215,7 +5219,7 @@ }, "connectEvent": { "$ref": "ConnectEvent", - "description": "A TCP connect event was initiated through the standard network stack. Part of NETWORK_LOGS." + "description": "A TCP connect event was initiated through the standard network stack. Part of NETWORK_ACTIVITY_LOGS." }, "cryptoSelfTestCompletedEvent": { "$ref": "CryptoSelfTestCompletedEvent", @@ -5223,7 +5227,7 @@ }, "dnsEvent": { "$ref": "DnsEvent", - "description": "A DNS lookup event was initiated through the standard network stack. Part of NETWORK_LOGS." + "description": "A DNS lookup event was initiated through the standard network stack. Part of NETWORK_ACTIVITY_LOGS." }, "eventId": { "description": "Unique id of the event.", @@ -5369,7 +5373,7 @@ }, "wipeFailureEvent": { "$ref": "WipeFailureEvent", - "description": "The work profile or company-owned device failed to wipe when when requested. This could be user initiated or admin initiated e.g. delete was received. Part of SECURITY_LOGS." + "description": "The work profile or company-owned device failed to wipe when requested. This could be user initiated or admin initiated e.g. delete was received. Part of SECURITY_LOGS." } }, "type": "object" @@ -5537,7 +5541,7 @@ "type": "object" }, "WipeFailureEvent": { - "description": "The work profile or company-owned device failed to wipe when when requested. This could be user initiated or admin initiated e.g. delete was received. Intentionally empty.", + "description": "The work profile or company-owned device failed to wipe when requested. This could be user initiated or admin initiated e.g. delete was received. Intentionally empty.", "id": "WipeFailureEvent", "properties": {}, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/androidpublisher.v3.json b/googleapiclient/discovery_cache/documents/androidpublisher.v3.json index e4f4144e488..c4eb98e5fa9 100644 --- a/googleapiclient/discovery_cache/documents/androidpublisher.v3.json +++ b/googleapiclient/discovery_cache/documents/androidpublisher.v3.json @@ -3915,7 +3915,7 @@ } } }, - "revision": "20220709", + "revision": "20220716", "rootUrl": "https://androidpublisher.googleapis.com/", "schemas": { "AcquisitionTargetingRule": { diff --git a/googleapiclient/discovery_cache/documents/apigateway.v1.json b/googleapiclient/discovery_cache/documents/apigateway.v1.json index 7c8a4451dc4..f570300d94a 100644 --- a/googleapiclient/discovery_cache/documents/apigateway.v1.json +++ b/googleapiclient/discovery_cache/documents/apigateway.v1.json @@ -1083,7 +1083,7 @@ } } }, - "revision": "20220623", + "revision": "20220707", "rootUrl": "https://apigateway.googleapis.com/", "schemas": { "ApigatewayApi": { diff --git a/googleapiclient/discovery_cache/documents/apigateway.v1beta.json b/googleapiclient/discovery_cache/documents/apigateway.v1beta.json index 4375e607949..57c11dffbc0 100644 --- a/googleapiclient/discovery_cache/documents/apigateway.v1beta.json +++ b/googleapiclient/discovery_cache/documents/apigateway.v1beta.json @@ -1083,7 +1083,7 @@ } } }, - "revision": "20220623", + "revision": "20220707", "rootUrl": "https://apigateway.googleapis.com/", "schemas": { "ApigatewayApi": { diff --git a/googleapiclient/discovery_cache/documents/apikeys.v2.json b/googleapiclient/discovery_cache/documents/apikeys.v2.json index 72626630fcd..f2873662ba4 100644 --- a/googleapiclient/discovery_cache/documents/apikeys.v2.json +++ b/googleapiclient/discovery_cache/documents/apikeys.v2.json @@ -396,7 +396,7 @@ } } }, - "revision": "20220706", + "revision": "20220715", "rootUrl": "https://apikeys.googleapis.com/", "schemas": { "Operation": { diff --git a/googleapiclient/discovery_cache/documents/appengine.v1.json b/googleapiclient/discovery_cache/documents/appengine.v1.json index 79b369afe82..ec57fde6b9a 100644 --- a/googleapiclient/discovery_cache/documents/appengine.v1.json +++ b/googleapiclient/discovery_cache/documents/appengine.v1.json @@ -1595,7 +1595,7 @@ } } }, - "revision": "20220625", + "revision": "20220711", "rootUrl": "https://appengine.googleapis.com/", "schemas": { "ApiConfigHandler": { diff --git a/googleapiclient/discovery_cache/documents/appengine.v1alpha.json b/googleapiclient/discovery_cache/documents/appengine.v1alpha.json index 23acda471e9..335dc5327a5 100644 --- a/googleapiclient/discovery_cache/documents/appengine.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/appengine.v1alpha.json @@ -887,7 +887,7 @@ } } }, - "revision": "20220625", + "revision": "20220711", "rootUrl": "https://appengine.googleapis.com/", "schemas": { "AuthorizedCertificate": { diff --git a/googleapiclient/discovery_cache/documents/appengine.v1beta.json b/googleapiclient/discovery_cache/documents/appengine.v1beta.json index a35f3527395..2e79b4453d3 100644 --- a/googleapiclient/discovery_cache/documents/appengine.v1beta.json +++ b/googleapiclient/discovery_cache/documents/appengine.v1beta.json @@ -1595,7 +1595,7 @@ } } }, - "revision": "20220625", + "revision": "20220711", "rootUrl": "https://appengine.googleapis.com/", "schemas": { "ApiConfigHandler": { diff --git a/googleapiclient/discovery_cache/documents/area120tables.v1alpha1.json b/googleapiclient/discovery_cache/documents/area120tables.v1alpha1.json index da701a15e48..1797ff6f9e5 100644 --- a/googleapiclient/discovery_cache/documents/area120tables.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/area120tables.v1alpha1.json @@ -586,7 +586,7 @@ } } }, - "revision": "20220708", + "revision": "20220715", "rootUrl": "https://area120tables.googleapis.com/", "schemas": { "BatchCreateRowsRequest": { diff --git a/googleapiclient/discovery_cache/documents/artifactregistry.v1.json b/googleapiclient/discovery_cache/documents/artifactregistry.v1.json index 8fea78b1596..45081b087e5 100644 --- a/googleapiclient/discovery_cache/documents/artifactregistry.v1.json +++ b/googleapiclient/discovery_cache/documents/artifactregistry.v1.json @@ -1408,7 +1408,7 @@ } } }, - "revision": "20220628", + "revision": "20220711", "rootUrl": "https://artifactregistry.googleapis.com/", "schemas": { "AptArtifact": { diff --git a/googleapiclient/discovery_cache/documents/artifactregistry.v1beta1.json b/googleapiclient/discovery_cache/documents/artifactregistry.v1beta1.json index a3dc5cc57f0..cb9664374bf 100644 --- a/googleapiclient/discovery_cache/documents/artifactregistry.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/artifactregistry.v1beta1.json @@ -929,7 +929,7 @@ } } }, - "revision": "20220628", + "revision": "20220711", "rootUrl": "https://artifactregistry.googleapis.com/", "schemas": { "Binding": { diff --git a/googleapiclient/discovery_cache/documents/artifactregistry.v1beta2.json b/googleapiclient/discovery_cache/documents/artifactregistry.v1beta2.json index 57c5bdcdc36..daa6f5e4892 100644 --- a/googleapiclient/discovery_cache/documents/artifactregistry.v1beta2.json +++ b/googleapiclient/discovery_cache/documents/artifactregistry.v1beta2.json @@ -1135,7 +1135,7 @@ } } }, - "revision": "20220628", + "revision": "20220711", "rootUrl": "https://artifactregistry.googleapis.com/", "schemas": { "AptArtifact": { diff --git a/googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1.json b/googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1.json index 82ed06fa18a..b0c9e7c0349 100644 --- a/googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1.json +++ b/googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1.json @@ -1307,7 +1307,7 @@ } } }, - "revision": "20220708", + "revision": "20220716", "rootUrl": "https://authorizedbuyersmarketplace.googleapis.com/", "schemas": { "AcceptProposalRequest": { diff --git a/googleapiclient/discovery_cache/documents/bigquery.v2.json b/googleapiclient/discovery_cache/documents/bigquery.v2.json index b2f1a89c6dc..0d4ecda77e7 100644 --- a/googleapiclient/discovery_cache/documents/bigquery.v2.json +++ b/googleapiclient/discovery_cache/documents/bigquery.v2.json @@ -1710,7 +1710,7 @@ } } }, - "revision": "20220611", + "revision": "20220709", "rootUrl": "https://bigquery.googleapis.com/", "schemas": { "AggregateClassificationMetrics": { diff --git a/googleapiclient/discovery_cache/documents/bigqueryconnection.v1beta1.json b/googleapiclient/discovery_cache/documents/bigqueryconnection.v1beta1.json index b0f4ed8e9d4..1a29cdbae74 100644 --- a/googleapiclient/discovery_cache/documents/bigqueryconnection.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/bigqueryconnection.v1beta1.json @@ -395,7 +395,7 @@ } } }, - "revision": "20220701", + "revision": "20220708", "rootUrl": "https://bigqueryconnection.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/googleapiclient/discovery_cache/documents/bigquerydatatransfer.v1.json b/googleapiclient/discovery_cache/documents/bigquerydatatransfer.v1.json index babd50502b3..0c8ee1aca97 100644 --- a/googleapiclient/discovery_cache/documents/bigquerydatatransfer.v1.json +++ b/googleapiclient/discovery_cache/documents/bigquerydatatransfer.v1.json @@ -1340,7 +1340,7 @@ } } }, - "revision": "20220701", + "revision": "20220709", "rootUrl": "https://bigquerydatatransfer.googleapis.com/", "schemas": { "CheckValidCredsRequest": { @@ -1876,7 +1876,7 @@ "type": "integer" }, "dataSourceId": { - "description": "Data source id. Cannot be changed once data transfer is created.", + "description": "Data source id. Cannot be changed once data transfer is created. The full list of available data source ids can be returned through API call: https://cloud.google.com/bigquery-transfer/docs/reference/datatransfer/rest/v1/projects.locations.dataSources/list The individual data source id can also be found in the bq tab in the 'Setting up a data transfer' section for each data source. For example, the data source id for Cloud Storage transfers is listed here: https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq", "type": "string" }, "datasetRegion": { diff --git a/googleapiclient/discovery_cache/documents/bigqueryreservation.v1.json b/googleapiclient/discovery_cache/documents/bigqueryreservation.v1.json index 2341035a174..14d368c7d49 100644 --- a/googleapiclient/discovery_cache/documents/bigqueryreservation.v1.json +++ b/googleapiclient/discovery_cache/documents/bigqueryreservation.v1.json @@ -823,7 +823,7 @@ } } }, - "revision": "20220630", + "revision": "20220703", "rootUrl": "https://bigqueryreservation.googleapis.com/", "schemas": { "Assignment": { diff --git a/googleapiclient/discovery_cache/documents/bigqueryreservation.v1beta1.json b/googleapiclient/discovery_cache/documents/bigqueryreservation.v1beta1.json index b4c65d56c3f..67aac28573f 100644 --- a/googleapiclient/discovery_cache/documents/bigqueryreservation.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/bigqueryreservation.v1beta1.json @@ -786,7 +786,7 @@ } } }, - "revision": "20220630", + "revision": "20220703", "rootUrl": "https://bigqueryreservation.googleapis.com/", "schemas": { "Assignment": { diff --git a/googleapiclient/discovery_cache/documents/blogger.v2.json b/googleapiclient/discovery_cache/documents/blogger.v2.json index cc4271404ec..d4b4518b116 100644 --- a/googleapiclient/discovery_cache/documents/blogger.v2.json +++ b/googleapiclient/discovery_cache/documents/blogger.v2.json @@ -401,7 +401,7 @@ } } }, - "revision": "20220708", + "revision": "20220715", "rootUrl": "https://blogger.googleapis.com/", "schemas": { "Blog": { diff --git a/googleapiclient/discovery_cache/documents/blogger.v3.json b/googleapiclient/discovery_cache/documents/blogger.v3.json index d3603994db9..0fcbc101ec1 100644 --- a/googleapiclient/discovery_cache/documents/blogger.v3.json +++ b/googleapiclient/discovery_cache/documents/blogger.v3.json @@ -1684,7 +1684,7 @@ } } }, - "revision": "20220708", + "revision": "20220715", "rootUrl": "https://blogger.googleapis.com/", "schemas": { "Blog": { diff --git a/googleapiclient/discovery_cache/documents/businessprofileperformance.v1.json b/googleapiclient/discovery_cache/documents/businessprofileperformance.v1.json index af292a5b110..4eb876ed355 100644 --- a/googleapiclient/discovery_cache/documents/businessprofileperformance.v1.json +++ b/googleapiclient/discovery_cache/documents/businessprofileperformance.v1.json @@ -323,7 +323,7 @@ } } }, - "revision": "20220708", + "revision": "20220716", "rootUrl": "https://businessprofileperformance.googleapis.com/", "schemas": { "Date": { diff --git a/googleapiclient/discovery_cache/documents/calendar.v3.json b/googleapiclient/discovery_cache/documents/calendar.v3.json index 97d90b94b83..109c887eff7 100644 --- a/googleapiclient/discovery_cache/documents/calendar.v3.json +++ b/googleapiclient/discovery_cache/documents/calendar.v3.json @@ -1723,7 +1723,7 @@ } } }, - "revision": "20220701", + "revision": "20220708", "rootUrl": "https://www.googleapis.com/", "schemas": { "Acl": { diff --git a/googleapiclient/discovery_cache/documents/chat.v1.json b/googleapiclient/discovery_cache/documents/chat.v1.json index e1d9e3bc6a1..eb3ed963263 100644 --- a/googleapiclient/discovery_cache/documents/chat.v1.json +++ b/googleapiclient/discovery_cache/documents/chat.v1.json @@ -642,7 +642,7 @@ } } }, - "revision": "20220701", + "revision": "20220708", "rootUrl": "https://chat.googleapis.com/", "schemas": { "ActionParameter": { @@ -2518,7 +2518,7 @@ "type": "string" }, "lastUpdateTime": { - "description": "Output only. The time at which the message was last updated. If the message was never updated, this field matches `create_time`.", + "description": "Output only. The time at which the message was last edited by a user. If the message has never been edited, this field is empty.", "format": "google-datetime", "readOnly": true, "type": "string" diff --git a/googleapiclient/discovery_cache/documents/chromeuxreport.v1.json b/googleapiclient/discovery_cache/documents/chromeuxreport.v1.json index 14304523542..b199e26d6bc 100644 --- a/googleapiclient/discovery_cache/documents/chromeuxreport.v1.json +++ b/googleapiclient/discovery_cache/documents/chromeuxreport.v1.json @@ -116,7 +116,7 @@ } } }, - "revision": "20220707", + "revision": "20220714", "rootUrl": "https://chromeuxreport.googleapis.com/", "schemas": { "Bin": { diff --git a/googleapiclient/discovery_cache/documents/classroom.v1.json b/googleapiclient/discovery_cache/documents/classroom.v1.json index d1b7829a8b8..9b2153ec624 100644 --- a/googleapiclient/discovery_cache/documents/classroom.v1.json +++ b/googleapiclient/discovery_cache/documents/classroom.v1.json @@ -2400,7 +2400,7 @@ } } }, - "revision": "20220706", + "revision": "20220713", "rootUrl": "https://classroom.googleapis.com/", "schemas": { "Announcement": { diff --git a/googleapiclient/discovery_cache/documents/cloudasset.v1.json b/googleapiclient/discovery_cache/documents/cloudasset.v1.json index e4677f5aa72..575fd0bf123 100644 --- a/googleapiclient/discovery_cache/documents/cloudasset.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudasset.v1.json @@ -929,7 +929,7 @@ } } }, - "revision": "20220701", + "revision": "20220715", "rootUrl": "https://cloudasset.googleapis.com/", "schemas": { "AccessSelector": { diff --git a/googleapiclient/discovery_cache/documents/cloudasset.v1beta1.json b/googleapiclient/discovery_cache/documents/cloudasset.v1beta1.json index 62a9b6796dc..7270a330474 100644 --- a/googleapiclient/discovery_cache/documents/cloudasset.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/cloudasset.v1beta1.json @@ -411,7 +411,7 @@ } } }, - "revision": "20220701", + "revision": "20220715", "rootUrl": "https://cloudasset.googleapis.com/", "schemas": { "AnalyzeIamPolicyLongrunningMetadata": { diff --git a/googleapiclient/discovery_cache/documents/cloudasset.v1p1beta1.json b/googleapiclient/discovery_cache/documents/cloudasset.v1p1beta1.json index 3fd5662c5e8..a9e25a452a4 100644 --- a/googleapiclient/discovery_cache/documents/cloudasset.v1p1beta1.json +++ b/googleapiclient/discovery_cache/documents/cloudasset.v1p1beta1.json @@ -207,7 +207,7 @@ } } }, - "revision": "20220701", + "revision": "20220708", "rootUrl": "https://cloudasset.googleapis.com/", "schemas": { "AnalyzeIamPolicyLongrunningMetadata": { diff --git a/googleapiclient/discovery_cache/documents/cloudasset.v1p5beta1.json b/googleapiclient/discovery_cache/documents/cloudasset.v1p5beta1.json index 4af97f73824..b1cb8e75c94 100644 --- a/googleapiclient/discovery_cache/documents/cloudasset.v1p5beta1.json +++ b/googleapiclient/discovery_cache/documents/cloudasset.v1p5beta1.json @@ -177,7 +177,7 @@ } } }, - "revision": "20220701", + "revision": "20220715", "rootUrl": "https://cloudasset.googleapis.com/", "schemas": { "AnalyzeIamPolicyLongrunningMetadata": { diff --git a/googleapiclient/discovery_cache/documents/cloudasset.v1p7beta1.json b/googleapiclient/discovery_cache/documents/cloudasset.v1p7beta1.json index 4d7ba1fc4f8..aee352578da 100644 --- a/googleapiclient/discovery_cache/documents/cloudasset.v1p7beta1.json +++ b/googleapiclient/discovery_cache/documents/cloudasset.v1p7beta1.json @@ -167,7 +167,7 @@ } } }, - "revision": "20220701", + "revision": "20220715", "rootUrl": "https://cloudasset.googleapis.com/", "schemas": { "AnalyzeIamPolicyLongrunningMetadata": { diff --git a/googleapiclient/discovery_cache/documents/cloudbilling.v1.json b/googleapiclient/discovery_cache/documents/cloudbilling.v1.json index 55c57316943..2ffc8b94741 100644 --- a/googleapiclient/discovery_cache/documents/cloudbilling.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudbilling.v1.json @@ -521,7 +521,7 @@ } } }, - "revision": "20220708", + "revision": "20220716", "rootUrl": "https://cloudbilling.googleapis.com/", "schemas": { "AggregationInfo": { diff --git a/googleapiclient/discovery_cache/documents/cloudchannel.v1.json b/googleapiclient/discovery_cache/documents/cloudchannel.v1.json index 753953f5028..8b32a394bc1 100644 --- a/googleapiclient/discovery_cache/documents/cloudchannel.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudchannel.v1.json @@ -1901,7 +1901,7 @@ } } }, - "revision": "20220708", + "revision": "20220715", "rootUrl": "https://cloudchannel.googleapis.com/", "schemas": { "GoogleCloudChannelV1ActivateEntitlementRequest": { diff --git a/googleapiclient/discovery_cache/documents/clouddebugger.v2.json b/googleapiclient/discovery_cache/documents/clouddebugger.v2.json index d42ce566245..2f53bf34d01 100644 --- a/googleapiclient/discovery_cache/documents/clouddebugger.v2.json +++ b/googleapiclient/discovery_cache/documents/clouddebugger.v2.json @@ -448,7 +448,7 @@ } } }, - "revision": "20220701", + "revision": "20220708", "rootUrl": "https://clouddebugger.googleapis.com/", "schemas": { "AliasContext": { diff --git a/googleapiclient/discovery_cache/documents/clouderrorreporting.v1beta1.json b/googleapiclient/discovery_cache/documents/clouderrorreporting.v1beta1.json index a132ae372a1..1ebfc14b0e9 100644 --- a/googleapiclient/discovery_cache/documents/clouderrorreporting.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/clouderrorreporting.v1beta1.json @@ -430,7 +430,7 @@ } } }, - "revision": "20220629", + "revision": "20220706", "rootUrl": "https://clouderrorreporting.googleapis.com/", "schemas": { "DeleteEventsResponse": { diff --git a/googleapiclient/discovery_cache/documents/cloudidentity.v1.json b/googleapiclient/discovery_cache/documents/cloudidentity.v1.json index b2906acea16..86a87c69116 100644 --- a/googleapiclient/discovery_cache/documents/cloudidentity.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudidentity.v1.json @@ -1439,7 +1439,7 @@ } } }, - "revision": "20220703", + "revision": "20220711", "rootUrl": "https://cloudidentity.googleapis.com/", "schemas": { "CheckTransitiveMembershipResponse": { diff --git a/googleapiclient/discovery_cache/documents/cloudidentity.v1beta1.json b/googleapiclient/discovery_cache/documents/cloudidentity.v1beta1.json index b7aec5cd96a..b7fe9a8e4a6 100644 --- a/googleapiclient/discovery_cache/documents/cloudidentity.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/cloudidentity.v1beta1.json @@ -1608,7 +1608,7 @@ } } }, - "revision": "20220703", + "revision": "20220711", "rootUrl": "https://cloudidentity.googleapis.com/", "schemas": { "AndroidAttributes": { diff --git a/googleapiclient/discovery_cache/documents/cloudprofiler.v2.json b/googleapiclient/discovery_cache/documents/cloudprofiler.v2.json index 9c9d71420a3..90ef436d9d6 100644 --- a/googleapiclient/discovery_cache/documents/cloudprofiler.v2.json +++ b/googleapiclient/discovery_cache/documents/cloudprofiler.v2.json @@ -216,7 +216,7 @@ } } }, - "revision": "20220627", + "revision": "20220708", "rootUrl": "https://cloudprofiler.googleapis.com/", "schemas": { "CreateProfileRequest": { diff --git a/googleapiclient/discovery_cache/documents/cloudresourcemanager.v1.json b/googleapiclient/discovery_cache/documents/cloudresourcemanager.v1.json index 30d56e2612b..94e3b99c747 100644 --- a/googleapiclient/discovery_cache/documents/cloudresourcemanager.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudresourcemanager.v1.json @@ -948,7 +948,7 @@ "parameterOrder": [], "parameters": { "filter": { - "description": "Optional. An expression for filtering the results of the request. Filter rules are case insensitive. If multiple fields are included in a filter query, the query will return results that match any of the fields. Some eligible fields for filtering are: + `name` + `id` + `labels.` (where *key* is the name of a label) + `parent.type` + `parent.id` + `lifecycleState` Some examples of filter queries: | Query | Description | |------------------|-----------------------------------------------------| | name:how* | The project's name starts with \"how\". | | name:Howl | The project's name is `Howl` or `howl`. | | name:HOWL | Equivalent to above. | | NAME:howl | Equivalent to above. | | labels.color:* | The project has the label `color`. | | labels.color:red | The project's label `color` has the value `red`. | | labels.color:red labels.size:big | The project's label `color` has the value `red` and its label `size` has the value `big`.| | lifecycleState:DELETE_REQUESTED | Only show projects that are pending deletion.| If no filter is specified, the call will return projects for which the user has the `resourcemanager.projects.get` permission. NOTE: To perform a by-parent query (eg., what projects are directly in a Folder), the caller must have the `resourcemanager.projects.list` permission on the parent and the filter must contain both a `parent.type` and a `parent.id` restriction (example: \"parent.type:folder parent.id:123\"). In this case an alternate search index is used which provides more consistent results.", + "description": "Optional. An expression for filtering the results of the request. Filter rules are case insensitive. If multiple fields are included in a filter query, the query will return results that match any of the fields. Some eligible fields for filtering are: + `name` + `id` + `labels.` (where *key* is the name of a label) + `parent.type` + `parent.id` + `lifecycleState` Some examples of filter queries: | Query | Description | |------------------|-----------------------------------------------------| | name:how* | The project's name starts with \"how\". | | name:Howl | The project's name is `Howl` or `howl`. | | name:HOWL | Equivalent to above. | | NAME:howl | Equivalent to above. | | labels.color:* | The project has the label `color`. | | labels.color:red | The project's label `color` has the value `red`. | | labels.color:red labels.size:big | The project's label `color` has the value `red` or its label `size` has the value `big`. | | lifecycleState:DELETE_REQUESTED | Only show projects that are pending deletion.| If no filter is specified, the call will return projects for which the user has the `resourcemanager.projects.get` permission. NOTE: To perform a by-parent query (eg., what projects are directly in a Folder), the caller must have the `resourcemanager.projects.list` permission on the parent and the filter must contain both a `parent.type` and a `parent.id` restriction (example: \"parent.type:folder parent.id:123\"). In this case an alternate search index is used which provides more consistent results.", "location": "query", "type": "string" }, @@ -1171,7 +1171,7 @@ } } }, - "revision": "20220703", + "revision": "20220717", "rootUrl": "https://cloudresourcemanager.googleapis.com/", "schemas": { "Ancestor": { diff --git a/googleapiclient/discovery_cache/documents/cloudresourcemanager.v1beta1.json b/googleapiclient/discovery_cache/documents/cloudresourcemanager.v1beta1.json index 697e589d855..ad143015cba 100644 --- a/googleapiclient/discovery_cache/documents/cloudresourcemanager.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/cloudresourcemanager.v1beta1.json @@ -429,7 +429,7 @@ "parameterOrder": [], "parameters": { "filter": { - "description": "An expression for filtering the results of the request. Filter rules are case insensitive. If multiple fields are included in a filter query, the query will return results that match any of the fields. Some eligible fields for filtering are: + `name` + `id` + `labels.` (where *key* is the name of a label) + `parent.type` + `parent.id` Some examples of using labels as filters: | Filter | Description | |------------------|-----------------------------------------------------| | name:how* | The project's name starts with \"how\". | | name:Howl | The project's name is `Howl` or `howl`. | | name:HOWL | Equivalent to above. | | NAME:howl | Equivalent to above. | | labels.color:* | The project has the label `color`. | | labels.color:red | The project's label `color` has the value `red`. | | labels.color:red labels.size:big |The project's label `color` has the value `red` and its label `size` has the value `big`. | If no filter is specified, the call will return projects for which the user has the `resourcemanager.projects.get` permission. NOTE: To perform a by-parent query (eg., what projects are directly in a Folder), the caller must have the `resourcemanager.projects.list` permission on the parent and the filter must contain both a `parent.type` and a `parent.id` restriction (example: \"parent.type:folder parent.id:123\"). In this case an alternate search index is used which provides more consistent results. Optional.", + "description": "An expression for filtering the results of the request. Filter rules are case insensitive. If multiple fields are included in a filter query, the query will return results that match any of the fields. Some eligible fields for filtering are: + `name` + `id` + `labels.` (where *key* is the name of a label) + `parent.type` + `parent.id` Some examples of using labels as filters: | Filter | Description | |------------------|-----------------------------------------------------| | name:how* | The project's name starts with \"how\". | | name:Howl | The project's name is `Howl` or `howl`. | | name:HOWL | Equivalent to above. | | NAME:howl | Equivalent to above. | | labels.color:* | The project has the label `color`. | | labels.color:red | The project's label `color` has the value `red`. | | labels.color:red labels.size:big | The project's label `color` has the value `red` or its label `size` has the value `big`. | If no filter is specified, the call will return projects for which the user has the `resourcemanager.projects.get` permission. NOTE: To perform a by-parent query (eg., what projects are directly in a Folder), the caller must have the `resourcemanager.projects.list` permission on the parent and the filter must contain both a `parent.type` and a `parent.id` restriction (example: \"parent.type:folder parent.id:123\"). In this case an alternate search index is used which provides more consistent results. Optional.", "location": "query", "type": "string" }, @@ -566,7 +566,7 @@ } } }, - "revision": "20220703", + "revision": "20220717", "rootUrl": "https://cloudresourcemanager.googleapis.com/", "schemas": { "Ancestor": { diff --git a/googleapiclient/discovery_cache/documents/cloudresourcemanager.v2.json b/googleapiclient/discovery_cache/documents/cloudresourcemanager.v2.json index df6f7374f05..52a711b50a7 100644 --- a/googleapiclient/discovery_cache/documents/cloudresourcemanager.v2.json +++ b/googleapiclient/discovery_cache/documents/cloudresourcemanager.v2.json @@ -450,7 +450,7 @@ } } }, - "revision": "20220703", + "revision": "20220717", "rootUrl": "https://cloudresourcemanager.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/googleapiclient/discovery_cache/documents/cloudresourcemanager.v2beta1.json b/googleapiclient/discovery_cache/documents/cloudresourcemanager.v2beta1.json index 34de8be5f46..c433aa92c1d 100644 --- a/googleapiclient/discovery_cache/documents/cloudresourcemanager.v2beta1.json +++ b/googleapiclient/discovery_cache/documents/cloudresourcemanager.v2beta1.json @@ -450,7 +450,7 @@ } } }, - "revision": "20220703", + "revision": "20220717", "rootUrl": "https://cloudresourcemanager.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/googleapiclient/discovery_cache/documents/cloudresourcemanager.v3.json b/googleapiclient/discovery_cache/documents/cloudresourcemanager.v3.json index 95334cef119..4dcf1973889 100644 --- a/googleapiclient/discovery_cache/documents/cloudresourcemanager.v3.json +++ b/googleapiclient/discovery_cache/documents/cloudresourcemanager.v3.json @@ -970,7 +970,7 @@ "type": "string" }, "query": { - "description": "Optional. A query string for searching for projects that the caller has `resourcemanager.projects.get` permission to. If multiple fields are included in the query, then it will return results that match any of the fields. Some eligible fields are: ``` | Field | Description | |-------------------------|----------------------------------------------| | displayName, name | Filters by displayName. | | parent | Project's parent (for example: folders/123, organizations/*). Prefer parent field over parent.type and parent.id.| | parent.type | Parent's type: `folder` or `organization`. | | parent.id | Parent's id number (for example: 123) | | id, projectId | Filters by projectId. | | state, lifecycleState | Filters by state. | | labels | Filters by label name or value. | | labels.\\ (where *key* is the name of a label) | Filters by label name.| ``` Search expressions are case insensitive. Some examples queries: ``` | Query | Description | |------------------|-----------------------------------------------------| | name:how* | The project's name starts with \"how\". | | name:Howl | The project's name is `Howl` or `howl`. | | name:HOWL | Equivalent to above. | | NAME:howl | Equivalent to above. | | labels.color:* | The project has the label `color`. | | labels.color:red | The project's label `color` has the value `red`. | | labels.color:red labels.size:big | The project's label `color` has the value `red` and its label `size` has the value `big`.| ``` If no query is specified, the call will return projects for which the user has the `resourcemanager.projects.get` permission.", + "description": "Optional. A query string for searching for projects that the caller has `resourcemanager.projects.get` permission to. If multiple fields are included in the query, then it will return results that match any of the fields. Some eligible fields are: ``` | Field | Description | |-------------------------|----------------------------------------------| | displayName, name | Filters by displayName. | | parent | Project's parent (for example: folders/123, organizations/*). Prefer parent field over parent.type and parent.id.| | parent.type | Parent's type: `folder` or `organization`. | | parent.id | Parent's id number (for example: 123) | | id, projectId | Filters by projectId. | | state, lifecycleState | Filters by state. | | labels | Filters by label name or value. | | labels.\\ (where *key* is the name of a label) | Filters by label name.| ``` Search expressions are case insensitive. Some examples queries: ``` | Query | Description | |------------------|-----------------------------------------------------| | name:how* | The project's name starts with \"how\". | | name:Howl | The project's name is `Howl` or `howl`. | | name:HOWL | Equivalent to above. | | NAME:howl | Equivalent to above. | | labels.color:* | The project has the label `color`. | | labels.color:red | The project's label `color` has the value `red`. | | labels.color:red labels.size:big | The project's label `color` has the value `red` or its label `size` has the value `big`. | ``` If no query is specified, the call will return projects for which the user has the `resourcemanager.projects.get` permission.", "location": "query", "type": "string" } @@ -1760,7 +1760,7 @@ } } }, - "revision": "20220703", + "revision": "20220717", "rootUrl": "https://cloudresourcemanager.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/googleapiclient/discovery_cache/documents/cloudshell.v1.json b/googleapiclient/discovery_cache/documents/cloudshell.v1.json index 3ca276c2561..039872ff1aa 100644 --- a/googleapiclient/discovery_cache/documents/cloudshell.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudshell.v1.json @@ -374,7 +374,7 @@ } } }, - "revision": "20220625", + "revision": "20220716", "rootUrl": "https://cloudshell.googleapis.com/", "schemas": { "AddPublicKeyMetadata": { diff --git a/googleapiclient/discovery_cache/documents/cloudsupport.v2beta.json b/googleapiclient/discovery_cache/documents/cloudsupport.v2beta.json index c88e7ddc9dc..d1268a87c68 100644 --- a/googleapiclient/discovery_cache/documents/cloudsupport.v2beta.json +++ b/googleapiclient/discovery_cache/documents/cloudsupport.v2beta.json @@ -575,7 +575,7 @@ } } }, - "revision": "20220708", + "revision": "20220713", "rootUrl": "https://cloudsupport.googleapis.com/", "schemas": { "Actor": { diff --git a/googleapiclient/discovery_cache/documents/cloudtrace.v1.json b/googleapiclient/discovery_cache/documents/cloudtrace.v1.json index 5ab486c2260..f5bcba5efe1 100644 --- a/googleapiclient/discovery_cache/documents/cloudtrace.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudtrace.v1.json @@ -257,7 +257,7 @@ } } }, - "revision": "20220622", + "revision": "20220706", "rootUrl": "https://cloudtrace.googleapis.com/", "schemas": { "Empty": { diff --git a/googleapiclient/discovery_cache/documents/cloudtrace.v2.json b/googleapiclient/discovery_cache/documents/cloudtrace.v2.json index 94c413b476f..d541b4d5de1 100644 --- a/googleapiclient/discovery_cache/documents/cloudtrace.v2.json +++ b/googleapiclient/discovery_cache/documents/cloudtrace.v2.json @@ -181,7 +181,7 @@ } } }, - "revision": "20220622", + "revision": "20220706", "rootUrl": "https://cloudtrace.googleapis.com/", "schemas": { "Annotation": { diff --git a/googleapiclient/discovery_cache/documents/cloudtrace.v2beta1.json b/googleapiclient/discovery_cache/documents/cloudtrace.v2beta1.json index 8eef8ab3c59..f96b6f9b91a 100644 --- a/googleapiclient/discovery_cache/documents/cloudtrace.v2beta1.json +++ b/googleapiclient/discovery_cache/documents/cloudtrace.v2beta1.json @@ -273,7 +273,7 @@ } } }, - "revision": "20220622", + "revision": "20220706", "rootUrl": "https://cloudtrace.googleapis.com/", "schemas": { "Empty": { diff --git a/googleapiclient/discovery_cache/documents/composer.v1.json b/googleapiclient/discovery_cache/documents/composer.v1.json index 43ac91e98ce..435cad6635c 100644 --- a/googleapiclient/discovery_cache/documents/composer.v1.json +++ b/googleapiclient/discovery_cache/documents/composer.v1.json @@ -406,7 +406,7 @@ } } }, - "revision": "20220628", + "revision": "20220708", "rootUrl": "https://composer.googleapis.com/", "schemas": { "AllowedIpRange": { diff --git a/googleapiclient/discovery_cache/documents/composer.v1beta1.json b/googleapiclient/discovery_cache/documents/composer.v1beta1.json index e8ef86bbc06..7fb68c623a6 100644 --- a/googleapiclient/discovery_cache/documents/composer.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/composer.v1beta1.json @@ -518,7 +518,7 @@ } } }, - "revision": "20220628", + "revision": "20220708", "rootUrl": "https://composer.googleapis.com/", "schemas": { "AllowedIpRange": { diff --git a/googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json b/googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json index d2402db8cf0..76ffad45933 100644 --- a/googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json +++ b/googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json @@ -1275,7 +1275,7 @@ } } }, - "revision": "20220703", + "revision": "20220708", "rootUrl": "https://contactcenterinsights.googleapis.com/", "schemas": { "GoogleCloudContactcenterinsightsV1Analysis": { diff --git a/googleapiclient/discovery_cache/documents/container.v1.json b/googleapiclient/discovery_cache/documents/container.v1.json index 372bc14b82e..c64d78b99fc 100644 --- a/googleapiclient/discovery_cache/documents/container.v1.json +++ b/googleapiclient/discovery_cache/documents/container.v1.json @@ -2487,7 +2487,7 @@ } } }, - "revision": "20220615", + "revision": "20220620", "rootUrl": "https://container.googleapis.com/", "schemas": { "AcceleratorConfig": { diff --git a/googleapiclient/discovery_cache/documents/container.v1beta1.json b/googleapiclient/discovery_cache/documents/container.v1beta1.json index 627b01bac20..89b48bccc86 100644 --- a/googleapiclient/discovery_cache/documents/container.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/container.v1beta1.json @@ -2512,7 +2512,7 @@ } } }, - "revision": "20220615", + "revision": "20220620", "rootUrl": "https://container.googleapis.com/", "schemas": { "AcceleratorConfig": { diff --git a/googleapiclient/discovery_cache/documents/customsearch.v1.json b/googleapiclient/discovery_cache/documents/customsearch.v1.json index ba77f037edc..7a51fc13e48 100644 --- a/googleapiclient/discovery_cache/documents/customsearch.v1.json +++ b/googleapiclient/discovery_cache/documents/customsearch.v1.json @@ -674,7 +674,7 @@ } } }, - "revision": "20220708", + "revision": "20220715", "rootUrl": "https://customsearch.googleapis.com/", "schemas": { "Promotion": { diff --git a/googleapiclient/discovery_cache/documents/dataflow.v1b3.json b/googleapiclient/discovery_cache/documents/dataflow.v1b3.json index f9b79d53919..506b18ef98d 100644 --- a/googleapiclient/discovery_cache/documents/dataflow.v1b3.json +++ b/googleapiclient/discovery_cache/documents/dataflow.v1b3.json @@ -2225,7 +2225,7 @@ } } }, - "revision": "20220629", + "revision": "20220706", "rootUrl": "https://dataflow.googleapis.com/", "schemas": { "ApproximateProgress": { diff --git a/googleapiclient/discovery_cache/documents/datamigration.v1.json b/googleapiclient/discovery_cache/documents/datamigration.v1.json index 7db9e4f0259..7a0524a4344 100644 --- a/googleapiclient/discovery_cache/documents/datamigration.v1.json +++ b/googleapiclient/discovery_cache/documents/datamigration.v1.json @@ -1049,7 +1049,7 @@ } } }, - "revision": "20220703", + "revision": "20220707", "rootUrl": "https://datamigration.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/googleapiclient/discovery_cache/documents/datamigration.v1beta1.json b/googleapiclient/discovery_cache/documents/datamigration.v1beta1.json index 981e95193b3..efe33df0a5b 100644 --- a/googleapiclient/discovery_cache/documents/datamigration.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/datamigration.v1beta1.json @@ -1049,7 +1049,7 @@ } } }, - "revision": "20220703", + "revision": "20220707", "rootUrl": "https://datamigration.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/googleapiclient/discovery_cache/documents/datapipelines.v1.json b/googleapiclient/discovery_cache/documents/datapipelines.v1.json index 6ac2aa9c0a2..b492f4fcb14 100644 --- a/googleapiclient/discovery_cache/documents/datapipelines.v1.json +++ b/googleapiclient/discovery_cache/documents/datapipelines.v1.json @@ -371,7 +371,7 @@ } } }, - "revision": "20220625", + "revision": "20220703", "rootUrl": "https://datapipelines.googleapis.com/", "schemas": { "GoogleCloudDatapipelinesV1DataflowJobDetails": { diff --git a/googleapiclient/discovery_cache/documents/deploymentmanager.alpha.json b/googleapiclient/discovery_cache/documents/deploymentmanager.alpha.json index acdb0d49e5f..1ba788fdcc3 100644 --- a/googleapiclient/discovery_cache/documents/deploymentmanager.alpha.json +++ b/googleapiclient/discovery_cache/documents/deploymentmanager.alpha.json @@ -1588,7 +1588,7 @@ } } }, - "revision": "20220707", + "revision": "20220714", "rootUrl": "https://deploymentmanager.googleapis.com/", "schemas": { "AsyncOptions": { @@ -2412,7 +2412,8 @@ "DEPRECATED_TYPE_USED", "PARTIAL_SUCCESS", "LARGE_DEPLOYMENT_WARNING", - "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE" + "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", + "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB" ], "enumDescriptions": [ "A link to a deprecated resource was created.", @@ -2440,7 +2441,8 @@ "When deploying and at least one of the resources has a type marked as deprecated", "Success is reported, but some results may be missing due to errors", "When deploying a deployment with a exceedingly large number of resources", - "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route." + "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", + "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2." ], "type": "string" }, @@ -2686,7 +2688,8 @@ "DEPRECATED_TYPE_USED", "PARTIAL_SUCCESS", "LARGE_DEPLOYMENT_WARNING", - "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE" + "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", + "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB" ], "enumDescriptions": [ "A link to a deprecated resource was created.", @@ -2714,7 +2717,8 @@ "When deploying and at least one of the resources has a type marked as deprecated", "Success is reported, but some results may be missing due to errors", "When deploying a deployment with a exceedingly large number of resources", - "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route." + "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", + "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2." ], "type": "string" }, @@ -2897,7 +2901,8 @@ "DEPRECATED_TYPE_USED", "PARTIAL_SUCCESS", "LARGE_DEPLOYMENT_WARNING", - "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE" + "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", + "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB" ], "enumDescriptions": [ "A link to a deprecated resource was created.", @@ -2925,7 +2930,8 @@ "When deploying and at least one of the resources has a type marked as deprecated", "Success is reported, but some results may be missing due to errors", "When deploying a deployment with a exceedingly large number of resources", - "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route." + "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", + "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/deploymentmanager.v2.json b/googleapiclient/discovery_cache/documents/deploymentmanager.v2.json index a5e8e571cf1..76fded46dbf 100644 --- a/googleapiclient/discovery_cache/documents/deploymentmanager.v2.json +++ b/googleapiclient/discovery_cache/documents/deploymentmanager.v2.json @@ -988,7 +988,7 @@ } } }, - "revision": "20220707", + "revision": "20220714", "rootUrl": "https://deploymentmanager.googleapis.com/", "schemas": { "AuditConfig": { @@ -1510,7 +1510,8 @@ "DEPRECATED_TYPE_USED", "PARTIAL_SUCCESS", "LARGE_DEPLOYMENT_WARNING", - "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE" + "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", + "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB" ], "enumDescriptions": [ "A link to a deprecated resource was created.", @@ -1538,7 +1539,8 @@ "When deploying and at least one of the resources has a type marked as deprecated", "Success is reported, but some results may be missing due to errors", "When deploying a deployment with a exceedingly large number of resources", - "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route." + "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", + "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2." ], "type": "string" }, @@ -1703,7 +1705,8 @@ "DEPRECATED_TYPE_USED", "PARTIAL_SUCCESS", "LARGE_DEPLOYMENT_WARNING", - "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE" + "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", + "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB" ], "enumDescriptions": [ "A link to a deprecated resource was created.", @@ -1731,7 +1734,8 @@ "When deploying and at least one of the resources has a type marked as deprecated", "Success is reported, but some results may be missing due to errors", "When deploying a deployment with a exceedingly large number of resources", - "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route." + "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", + "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2." ], "type": "string" }, @@ -1891,7 +1895,8 @@ "DEPRECATED_TYPE_USED", "PARTIAL_SUCCESS", "LARGE_DEPLOYMENT_WARNING", - "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE" + "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", + "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB" ], "enumDescriptions": [ "A link to a deprecated resource was created.", @@ -1919,7 +1924,8 @@ "When deploying and at least one of the resources has a type marked as deprecated", "Success is reported, but some results may be missing due to errors", "When deploying a deployment with a exceedingly large number of resources", - "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route." + "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", + "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/deploymentmanager.v2beta.json b/googleapiclient/discovery_cache/documents/deploymentmanager.v2beta.json index 354ea690f84..bb3f7ebc54e 100644 --- a/googleapiclient/discovery_cache/documents/deploymentmanager.v2beta.json +++ b/googleapiclient/discovery_cache/documents/deploymentmanager.v2beta.json @@ -1552,7 +1552,7 @@ } } }, - "revision": "20220707", + "revision": "20220714", "rootUrl": "https://deploymentmanager.googleapis.com/", "schemas": { "AsyncOptions": { @@ -2315,7 +2315,8 @@ "DEPRECATED_TYPE_USED", "PARTIAL_SUCCESS", "LARGE_DEPLOYMENT_WARNING", - "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE" + "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", + "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB" ], "enumDescriptions": [ "A link to a deprecated resource was created.", @@ -2343,7 +2344,8 @@ "When deploying and at least one of the resources has a type marked as deprecated", "Success is reported, but some results may be missing due to errors", "When deploying a deployment with a exceedingly large number of resources", - "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route." + "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", + "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2." ], "type": "string" }, @@ -2566,7 +2568,8 @@ "DEPRECATED_TYPE_USED", "PARTIAL_SUCCESS", "LARGE_DEPLOYMENT_WARNING", - "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE" + "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", + "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB" ], "enumDescriptions": [ "A link to a deprecated resource was created.", @@ -2594,7 +2597,8 @@ "When deploying and at least one of the resources has a type marked as deprecated", "Success is reported, but some results may be missing due to errors", "When deploying a deployment with a exceedingly large number of resources", - "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route." + "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", + "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2." ], "type": "string" }, @@ -2754,7 +2758,8 @@ "DEPRECATED_TYPE_USED", "PARTIAL_SUCCESS", "LARGE_DEPLOYMENT_WARNING", - "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE" + "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", + "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB" ], "enumDescriptions": [ "A link to a deprecated resource was created.", @@ -2782,7 +2787,8 @@ "When deploying and at least one of the resources has a type marked as deprecated", "Success is reported, but some results may be missing due to errors", "When deploying a deployment with a exceedingly large number of resources", - "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route." + "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", + "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/digitalassetlinks.v1.json b/googleapiclient/discovery_cache/documents/digitalassetlinks.v1.json index 38591d350fa..6eedd94f696 100644 --- a/googleapiclient/discovery_cache/documents/digitalassetlinks.v1.json +++ b/googleapiclient/discovery_cache/documents/digitalassetlinks.v1.json @@ -199,7 +199,7 @@ } } }, - "revision": "20220704", + "revision": "20220712", "rootUrl": "https://digitalassetlinks.googleapis.com/", "schemas": { "AndroidAppAsset": { diff --git a/googleapiclient/discovery_cache/documents/displayvideo.v1.json b/googleapiclient/discovery_cache/documents/displayvideo.v1.json index 409d3379d7a..faef3aaca93 100644 --- a/googleapiclient/discovery_cache/documents/displayvideo.v1.json +++ b/googleapiclient/discovery_cache/documents/displayvideo.v1.json @@ -8146,7 +8146,7 @@ } } }, - "revision": "20220711", + "revision": "20220714", "rootUrl": "https://displayvideo.googleapis.com/", "schemas": { "ActivateManualTriggerRequest": { diff --git a/googleapiclient/discovery_cache/documents/dlp.v2.json b/googleapiclient/discovery_cache/documents/dlp.v2.json index 407cf9ceef7..7d68a256596 100644 --- a/googleapiclient/discovery_cache/documents/dlp.v2.json +++ b/googleapiclient/discovery_cache/documents/dlp.v2.json @@ -3412,7 +3412,7 @@ } } }, - "revision": "20220619", + "revision": "20220708", "rootUrl": "https://dlp.googleapis.com/", "schemas": { "GooglePrivacyDlpV2Action": { @@ -5252,7 +5252,7 @@ }, "proximity": { "$ref": "GooglePrivacyDlpV2Proximity", - "description": "Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex \"\\(\\d{3}\\) \\d{3}-\\d{4}\" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex \"\\(xxx\\)\", where \"xxx\" is the area code in question." + "description": "Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex \"\\(\\d{3}\\) \\d{3}-\\d{4}\" if the area code is known to be the area code of a company's office. In this case, use the hotword regex \"\\(xxx\\)\", where \"xxx\" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values)." } }, "type": "object" @@ -6784,7 +6784,7 @@ "type": "integer" }, "windowBefore": { - "description": "Number of characters before the finding to consider.", + "description": "Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://cloud.google.com/dlp/docs/creating-custom-infotypes-likelihood#match-column-values).", "format": "int32", "type": "integer" } diff --git a/googleapiclient/discovery_cache/documents/dns.v1.json b/googleapiclient/discovery_cache/documents/dns.v1.json index 0af6b04042c..1eaa374bf25 100644 --- a/googleapiclient/discovery_cache/documents/dns.v1.json +++ b/googleapiclient/discovery_cache/documents/dns.v1.json @@ -1824,7 +1824,7 @@ } } }, - "revision": "20220630", + "revision": "20220706", "rootUrl": "https://dns.googleapis.com/", "schemas": { "Change": { diff --git a/googleapiclient/discovery_cache/documents/dns.v1beta2.json b/googleapiclient/discovery_cache/documents/dns.v1beta2.json index 95284185b6d..826b9703d40 100644 --- a/googleapiclient/discovery_cache/documents/dns.v1beta2.json +++ b/googleapiclient/discovery_cache/documents/dns.v1beta2.json @@ -1821,7 +1821,7 @@ } } }, - "revision": "20220630", + "revision": "20220706", "rootUrl": "https://dns.googleapis.com/", "schemas": { "Change": { diff --git a/googleapiclient/discovery_cache/documents/docs.v1.json b/googleapiclient/discovery_cache/documents/docs.v1.json index 5443b9d94d2..87d21825913 100644 --- a/googleapiclient/discovery_cache/documents/docs.v1.json +++ b/googleapiclient/discovery_cache/documents/docs.v1.json @@ -216,7 +216,7 @@ } } }, - "revision": "20220628", + "revision": "20220708", "rootUrl": "https://docs.googleapis.com/", "schemas": { "AutoText": { diff --git a/googleapiclient/discovery_cache/documents/domains.v1.json b/googleapiclient/discovery_cache/documents/domains.v1.json index d32dc0e9e0e..5a5fd1e305b 100644 --- a/googleapiclient/discovery_cache/documents/domains.v1.json +++ b/googleapiclient/discovery_cache/documents/domains.v1.json @@ -843,7 +843,7 @@ } } }, - "revision": "20220616", + "revision": "20220712", "rootUrl": "https://domains.googleapis.com/", "schemas": { "AuditConfig": { @@ -1566,7 +1566,7 @@ "type": "object" }, "PostalAddress": { - "description": "Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478", + "description": "Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478", "id": "PostalAddress", "properties": { "addressLines": { diff --git a/googleapiclient/discovery_cache/documents/domains.v1alpha2.json b/googleapiclient/discovery_cache/documents/domains.v1alpha2.json index e8fa8a523a3..2eb4d49457c 100644 --- a/googleapiclient/discovery_cache/documents/domains.v1alpha2.json +++ b/googleapiclient/discovery_cache/documents/domains.v1alpha2.json @@ -843,7 +843,7 @@ } } }, - "revision": "20220616", + "revision": "20220712", "rootUrl": "https://domains.googleapis.com/", "schemas": { "AuditConfig": { @@ -1566,7 +1566,7 @@ "type": "object" }, "PostalAddress": { - "description": "Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478", + "description": "Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478", "id": "PostalAddress", "properties": { "addressLines": { diff --git a/googleapiclient/discovery_cache/documents/domains.v1beta1.json b/googleapiclient/discovery_cache/documents/domains.v1beta1.json index ab948dd6507..035eb44728e 100644 --- a/googleapiclient/discovery_cache/documents/domains.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/domains.v1beta1.json @@ -843,7 +843,7 @@ } } }, - "revision": "20220616", + "revision": "20220712", "rootUrl": "https://domains.googleapis.com/", "schemas": { "AuditConfig": { @@ -1566,7 +1566,7 @@ "type": "object" }, "PostalAddress": { - "description": "Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478", + "description": "Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478", "id": "PostalAddress", "properties": { "addressLines": { diff --git a/googleapiclient/discovery_cache/documents/domainsrdap.v1.json b/googleapiclient/discovery_cache/documents/domainsrdap.v1.json index 048de3a039a..5149148cd32 100644 --- a/googleapiclient/discovery_cache/documents/domainsrdap.v1.json +++ b/googleapiclient/discovery_cache/documents/domainsrdap.v1.json @@ -289,7 +289,7 @@ } } }, - "revision": "20220711", + "revision": "20220716", "rootUrl": "https://domainsrdap.googleapis.com/", "schemas": { "HttpBody": { diff --git a/googleapiclient/discovery_cache/documents/doubleclickbidmanager.v1.1.json b/googleapiclient/discovery_cache/documents/doubleclickbidmanager.v1.1.json index 84b6786692f..77eb8613153 100644 --- a/googleapiclient/discovery_cache/documents/doubleclickbidmanager.v1.1.json +++ b/googleapiclient/discovery_cache/documents/doubleclickbidmanager.v1.1.json @@ -280,7 +280,7 @@ } } }, - "revision": "20220627", + "revision": "20220707", "rootUrl": "https://doubleclickbidmanager.googleapis.com/", "schemas": { "ChannelGrouping": { diff --git a/googleapiclient/discovery_cache/documents/doubleclickbidmanager.v2.json b/googleapiclient/discovery_cache/documents/doubleclickbidmanager.v2.json index bf003fc89a9..b0b5df42484 100644 --- a/googleapiclient/discovery_cache/documents/doubleclickbidmanager.v2.json +++ b/googleapiclient/discovery_cache/documents/doubleclickbidmanager.v2.json @@ -126,7 +126,7 @@ ] }, "delete": { - "description": "Deletes a stored query as well as the associated stored reports.", + "description": "Deletes a query as well as the associated reports.", "flatPath": "queries/{queryId}", "httpMethod": "DELETE", "id": "doubleclickbidmanager.queries.delete", @@ -135,7 +135,7 @@ ], "parameters": { "queryId": { - "description": "Required. Query ID to delete.", + "description": "Required. ID of query to delete.", "format": "int64", "location": "path", "required": true, @@ -148,7 +148,7 @@ ] }, "get": { - "description": "Retrieves a stored query.", + "description": "Retrieves a query.", "flatPath": "queries/{queryId}", "httpMethod": "GET", "id": "doubleclickbidmanager.queries.get", @@ -157,7 +157,7 @@ ], "parameters": { "queryId": { - "description": "Required. Query ID to retrieve.", + "description": "Required. ID of query to retrieve.", "format": "int64", "location": "path", "required": true, @@ -173,14 +173,14 @@ ] }, "list": { - "description": "Retrieves stored queries.", + "description": "Lists queries created by the current user.", "flatPath": "queries", "httpMethod": "GET", "id": "doubleclickbidmanager.queries.list", "parameterOrder": [], "parameters": { "orderBy": { - "description": "Name of a field used to order results. The default sorting order is ascending. To specify descending order for a field, append a \" desc\" suffix. For example \"metadata.title desc\". Sorting is only supported for the following fields: * queryId * metadata.title", + "description": "Name of a field used to order results. The default sorting order is ascending. To specify descending order for a field, append a \" desc\" suffix. For example \"metadata.title desc\". Sorting is only supported for the following fields: * `queryId` * `metadata.title`", "location": "query", "type": "string" }, @@ -214,7 +214,7 @@ ], "parameters": { "queryId": { - "description": "Required. Query ID to run.", + "description": "Required. ID of query to run.", "format": "int64", "location": "path", "required": true, @@ -242,7 +242,7 @@ "reports": { "methods": { "get": { - "description": "Retrieves a stored report.", + "description": "Retrieves a report.", "flatPath": "queries/{queryId}/reports/{reportId}", "httpMethod": "GET", "id": "doubleclickbidmanager.queries.reports.get", @@ -275,7 +275,7 @@ ] }, "list": { - "description": "Lists reports.", + "description": "Lists reports associated with a query.", "flatPath": "queries/{queryId}/reports", "httpMethod": "GET", "id": "doubleclickbidmanager.queries.reports.list", @@ -284,7 +284,7 @@ ], "parameters": { "orderBy": { - "description": "Name of a field used to order results. The default sorting order is ascending. To specify descending order for a field, append a \" desc\" suffix. For example \"key.reportId desc\". Sorting is only supported for the following fields: * key.reportId", + "description": "Name of a field used to order results. The default sorting order is ascending. To specify descending order for a field, append a \" desc\" suffix. For example \"key.reportId desc\". Sorting is only supported for the following fields: * `key.reportId`", "location": "query", "type": "string" }, @@ -300,7 +300,7 @@ "type": "string" }, "queryId": { - "description": "Required. Query ID with which the reports are associated.", + "description": "Required. ID of the query with which the reports are associated.", "format": "int64", "location": "path", "required": true, @@ -320,7 +320,7 @@ } } }, - "revision": "20220627", + "revision": "20220707", "rootUrl": "https://doubleclickbidmanager.googleapis.com/", "schemas": { "ChannelGrouping": { @@ -381,25 +381,25 @@ "LAST_60_DAYS" ], "enumDescriptions": [ - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "" + "Default value when range is not specified or is unknown in this version.", + "Custom range specified by custom_start_date and custom_end_date fields.", + "Current day.", + "Previous day.", + "All days, including the current day, since the most recent Sunday.", + "All days, including the current day, since the start of the current month.", + "All days, including the current day, since the start of the current quarter.", + "All days, including the current day, since the start of the current calendar year.", + "The previous completed week, beginning from Sunday.", + "The previous completed calendar month.", + "The previous completed quarter.", + "The previous completed calendar year.", + "The previous 7 days, excluding the current day.", + "The previous 30 days, excluding the current day.", + "The previous 90 days, excluding the current day.", + "The previous 365 days, excluding the current day.", + "All time for which data is available, excluding the current day.", + "The previous 14 days, excluding the current day.", + "The previous 60 days, excluding the current day." ], "type": "string" } @@ -469,15 +469,14 @@ "type": "object" }, "ListQueriesResponse": { - "description": "Represents a list of queries.", "id": "ListQueriesResponse", "properties": { "nextPageToken": { - "description": "A token, which can be sent as `page_token` to retrieve the next page of queries. If this field is omitted, there are no subsequent pages.", + "description": "A token, which can be sent as page_token to retrieve the next page of queries. If this field is omitted, there are no subsequent pages.", "type": "string" }, "queries": { - "description": "Retrieved queries.", + "description": "The list of queries.", "items": { "$ref": "Query" }, @@ -487,11 +486,10 @@ "type": "object" }, "ListReportsResponse": { - "description": "Represents a list of reports.", "id": "ListReportsResponse", "properties": { "nextPageToken": { - "description": "A token, which can be sent as `page_token` to retrieve the next page of reports. If this field is omitted, there are no subsequent pages.", + "description": "A token, which can be sent as page_token to retrieve the next page of reports. If this field is omitted, there are no subsequent pages.", "type": "string" }, "reports": { @@ -549,7 +547,7 @@ "description": "Additional query options." }, "type": { - "description": "Report type.", + "description": "The type of the report. The type of the report will dictate what dimesions, filters, and metrics can be used.", "enum": [ "REPORT_TYPE_UNSPECIFIED", "STANDARD", @@ -565,18 +563,18 @@ "PATH_ATTRIBUTION" ], "enumDescriptions": [ - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "" + "Default value when report type is not specified or is unknown in this version.", + "Standard report.", + "Inventory Availability report.", + "Audience Composition report.", + "Floodlight report.", + "YouTube report.", + "GRP report.", + "YouTube Programmatic Guaranteed report.", + "Reach report.", + "Unique Reach Audience report.", + "Full Path report.", + "Path Attribution report." ], "type": "string" } @@ -595,7 +593,7 @@ "type": "array" }, "pathMatchPosition": { - "description": "Indicates the position of the path the filter should match to (first, last, or any event in path).", + "description": "The position of the path the filter should match to (first, last, or any event in path).", "enum": [ "PATH_MATCH_POSITION_UNSPECIFIED", "ANY", @@ -603,10 +601,10 @@ "LAST" ], "enumDescriptions": [ - "", - "", - "", - "" + "Default value when path match position is not specified or is unknown in this version.", + "Any position in the path.", + "The first position in the path.", + "The last position in the path." ], "type": "string" } @@ -632,7 +630,7 @@ "type": "object" }, "PathQueryOptionsFilter": { - "description": "Dimension Filter on path events.", + "description": "Dimension filter on path events.", "id": "PathQueryOptionsFilter", "properties": { "filter": { @@ -640,7 +638,7 @@ "type": "string" }, "match": { - "description": "Indicates how the filter should be matched to the value.", + "description": "Match logic of the filter.", "enum": [ "UNKNOWN", "EXACT", @@ -649,16 +647,16 @@ "WILDCARD_EXPRESSION" ], "enumDescriptions": [ - "", - "", - "", - "", - "" + "Default value when match is not specified or is unknown in this version.", + "Matches a value exactly.", + "Matches a value partially.", + "Begins with a value.", + "Matches a value, utilizing wildcard character logic in the value." ], "type": "string" }, "values": { - "description": "Value to filter on.", + "description": "Values to filter on.", "items": { "type": "string" }, @@ -687,7 +685,7 @@ }, "schedule": { "$ref": "QuerySchedule", - "description": "Information on how often and when to run a query." + "description": "Information on how often and when to run a query. If `ONE_TIME` is set to the frequency field, the query will only be run at the time of creation." } }, "type": "object" @@ -698,7 +696,7 @@ "properties": { "dataRange": { "$ref": "DataRange", - "description": "Range of report data." + "description": "Range of report data. All reports will be based on the same time zone as used by the advertiser." }, "format": { "description": "Format of the generated report.", @@ -719,7 +717,7 @@ "type": "boolean" }, "shareEmailAddress": { - "description": "List of email addresses which are sent email notifications when the report is finished. Separate from `sendNotification`.", + "description": "List of email addresses which are sent email notifications when the report is finished. Separate from send_notification.", "items": { "type": "string" }, @@ -733,7 +731,7 @@ "type": "object" }, "QuerySchedule": { - "description": "Information on how frequently and when to run a query.", + "description": "Information on when and how frequently to run a query.", "id": "QuerySchedule", "properties": { "endDate": { @@ -753,14 +751,14 @@ "YEARLY" ], "enumDescriptions": [ - "", - "", - "", - "", - "", - "", - "", - "" + "Default value when frequency is not specified or is unknown in this version.", + "Only once.", + "Once a day.", + "Once a week.", + "Twice a month.", + "Once a month.", + "Once a quarter", + "Once a year." ], "type": "string" }, @@ -871,11 +869,11 @@ "FAILED" ], "enumDescriptions": [ - "", - "", - "", - "", - "" + "Default value when state is not specified or is unknown in this version.", + "The report is queued to run.", + "The report is currently running.", + "The report has finished running successfully.", + "The report has finished running in failure." ], "readOnly": true, "type": "string" diff --git a/googleapiclient/discovery_cache/documents/doubleclicksearch.v2.json b/googleapiclient/discovery_cache/documents/doubleclicksearch.v2.json index 12ae45191ac..83f9478fa02 100644 --- a/googleapiclient/discovery_cache/documents/doubleclicksearch.v2.json +++ b/googleapiclient/discovery_cache/documents/doubleclicksearch.v2.json @@ -434,7 +434,7 @@ } } }, - "revision": "20220706", + "revision": "20220712", "rootUrl": "https://doubleclicksearch.googleapis.com/", "schemas": { "Availability": { diff --git a/googleapiclient/discovery_cache/documents/driveactivity.v2.json b/googleapiclient/discovery_cache/documents/driveactivity.v2.json index 73f7a478b18..f574a48d3af 100644 --- a/googleapiclient/discovery_cache/documents/driveactivity.v2.json +++ b/googleapiclient/discovery_cache/documents/driveactivity.v2.json @@ -132,7 +132,7 @@ } } }, - "revision": "20220703", + "revision": "20220712", "rootUrl": "https://driveactivity.googleapis.com/", "schemas": { "Action": { diff --git a/googleapiclient/discovery_cache/documents/essentialcontacts.v1.json b/googleapiclient/discovery_cache/documents/essentialcontacts.v1.json index 1e9daa1d62a..1482641498a 100644 --- a/googleapiclient/discovery_cache/documents/essentialcontacts.v1.json +++ b/googleapiclient/discovery_cache/documents/essentialcontacts.v1.json @@ -850,7 +850,7 @@ } } }, - "revision": "20220708", + "revision": "20220715", "rootUrl": "https://essentialcontacts.googleapis.com/", "schemas": { "GoogleCloudEssentialcontactsV1ComputeContactsResponse": { diff --git a/googleapiclient/discovery_cache/documents/eventarc.v1.json b/googleapiclient/discovery_cache/documents/eventarc.v1.json index ef5d2caec55..6ab951c04e4 100644 --- a/googleapiclient/discovery_cache/documents/eventarc.v1.json +++ b/googleapiclient/discovery_cache/documents/eventarc.v1.json @@ -1197,7 +1197,7 @@ } } }, - "revision": "20220628", + "revision": "20220711", "rootUrl": "https://eventarc.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/googleapiclient/discovery_cache/documents/eventarc.v1beta1.json b/googleapiclient/discovery_cache/documents/eventarc.v1beta1.json index 3e50e0d260e..b1ea0e9ae48 100644 --- a/googleapiclient/discovery_cache/documents/eventarc.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/eventarc.v1beta1.json @@ -584,7 +584,7 @@ } } }, - "revision": "20220628", + "revision": "20220711", "rootUrl": "https://eventarc.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/googleapiclient/discovery_cache/documents/factchecktools.v1alpha1.json b/googleapiclient/discovery_cache/documents/factchecktools.v1alpha1.json index 22732095c1e..7fcad385d24 100644 --- a/googleapiclient/discovery_cache/documents/factchecktools.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/factchecktools.v1alpha1.json @@ -304,7 +304,7 @@ } } }, - "revision": "20220708", + "revision": "20220715", "rootUrl": "https://factchecktools.googleapis.com/", "schemas": { "GoogleFactcheckingFactchecktoolsV1alpha1Claim": { diff --git a/googleapiclient/discovery_cache/documents/fcm.v1.json b/googleapiclient/discovery_cache/documents/fcm.v1.json index f0ebc12f68b..ed15d408b70 100644 --- a/googleapiclient/discovery_cache/documents/fcm.v1.json +++ b/googleapiclient/discovery_cache/documents/fcm.v1.json @@ -146,7 +146,7 @@ } } }, - "revision": "20220627", + "revision": "20220718", "rootUrl": "https://fcm.googleapis.com/", "schemas": { "AndroidConfig": { diff --git a/googleapiclient/discovery_cache/documents/fcmdata.v1beta1.json b/googleapiclient/discovery_cache/documents/fcmdata.v1beta1.json index b3bfa9ad6c5..7b8b92b9b1a 100644 --- a/googleapiclient/discovery_cache/documents/fcmdata.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/fcmdata.v1beta1.json @@ -154,7 +154,7 @@ } } }, - "revision": "20220708", + "revision": "20220715", "rootUrl": "https://fcmdata.googleapis.com/", "schemas": { "GoogleFirebaseFcmDataV1beta1AndroidDeliveryData": { diff --git a/googleapiclient/discovery_cache/documents/firebase.v1beta1.json b/googleapiclient/discovery_cache/documents/firebase.v1beta1.json index d589834c81c..58efe832096 100644 --- a/googleapiclient/discovery_cache/documents/firebase.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/firebase.v1beta1.json @@ -1225,7 +1225,7 @@ } } }, - "revision": "20220707", + "revision": "20220713", "rootUrl": "https://firebase.googleapis.com/", "schemas": { "AddFirebaseRequest": { diff --git a/googleapiclient/discovery_cache/documents/firebaseappcheck.v1.json b/googleapiclient/discovery_cache/documents/firebaseappcheck.v1.json index 53e32437e95..d8068ce322e 100644 --- a/googleapiclient/discovery_cache/documents/firebaseappcheck.v1.json +++ b/googleapiclient/discovery_cache/documents/firebaseappcheck.v1.json @@ -1338,7 +1338,7 @@ } } }, - "revision": "20220625", + "revision": "20220708", "rootUrl": "https://firebaseappcheck.googleapis.com/", "schemas": { "GoogleFirebaseAppcheckV1AppAttestConfig": { diff --git a/googleapiclient/discovery_cache/documents/firebaseappcheck.v1beta.json b/googleapiclient/discovery_cache/documents/firebaseappcheck.v1beta.json index 8c8c08e8c9c..e68306e34f1 100644 --- a/googleapiclient/discovery_cache/documents/firebaseappcheck.v1beta.json +++ b/googleapiclient/discovery_cache/documents/firebaseappcheck.v1beta.json @@ -1464,7 +1464,7 @@ } } }, - "revision": "20220625", + "revision": "20220708", "rootUrl": "https://firebaseappcheck.googleapis.com/", "schemas": { "GoogleFirebaseAppcheckV1betaAppAttestConfig": { diff --git a/googleapiclient/discovery_cache/documents/firebasedatabase.v1beta.json b/googleapiclient/discovery_cache/documents/firebasedatabase.v1beta.json index f0943d187ed..7432927c8bd 100644 --- a/googleapiclient/discovery_cache/documents/firebasedatabase.v1beta.json +++ b/googleapiclient/discovery_cache/documents/firebasedatabase.v1beta.json @@ -351,7 +351,7 @@ } } }, - "revision": "20220707", + "revision": "20220713", "rootUrl": "https://firebasedatabase.googleapis.com/", "schemas": { "DatabaseInstance": { diff --git a/googleapiclient/discovery_cache/documents/firebasedynamiclinks.v1.json b/googleapiclient/discovery_cache/documents/firebasedynamiclinks.v1.json index 47befcf521c..6e0a4ac9cb4 100644 --- a/googleapiclient/discovery_cache/documents/firebasedynamiclinks.v1.json +++ b/googleapiclient/discovery_cache/documents/firebasedynamiclinks.v1.json @@ -224,7 +224,7 @@ } } }, - "revision": "20220703", + "revision": "20220713", "rootUrl": "https://firebasedynamiclinks.googleapis.com/", "schemas": { "AnalyticsInfo": { diff --git a/googleapiclient/discovery_cache/documents/firebaseml.v1.json b/googleapiclient/discovery_cache/documents/firebaseml.v1.json index 84ac1c75f5d..defec57b76e 100644 --- a/googleapiclient/discovery_cache/documents/firebaseml.v1.json +++ b/googleapiclient/discovery_cache/documents/firebaseml.v1.json @@ -204,7 +204,7 @@ } } }, - "revision": "20220706", + "revision": "20220713", "rootUrl": "https://firebaseml.googleapis.com/", "schemas": { "CancelOperationRequest": { diff --git a/googleapiclient/discovery_cache/documents/firebaseml.v1beta2.json b/googleapiclient/discovery_cache/documents/firebaseml.v1beta2.json index ac8008494de..5b590253870 100644 --- a/googleapiclient/discovery_cache/documents/firebaseml.v1beta2.json +++ b/googleapiclient/discovery_cache/documents/firebaseml.v1beta2.json @@ -318,7 +318,7 @@ } } }, - "revision": "20220706", + "revision": "20220713", "rootUrl": "https://firebaseml.googleapis.com/", "schemas": { "DownloadModelResponse": { diff --git a/googleapiclient/discovery_cache/documents/firebasestorage.v1beta.json b/googleapiclient/discovery_cache/documents/firebasestorage.v1beta.json index 5742c2c861d..a3c8e47e551 100644 --- a/googleapiclient/discovery_cache/documents/firebasestorage.v1beta.json +++ b/googleapiclient/discovery_cache/documents/firebasestorage.v1beta.json @@ -238,7 +238,7 @@ } } }, - "revision": "20220610", + "revision": "20220623", "rootUrl": "https://firebasestorage.googleapis.com/", "schemas": { "AddFirebaseRequest": { diff --git a/googleapiclient/discovery_cache/documents/fitness.v1.json b/googleapiclient/discovery_cache/documents/fitness.v1.json index 324ca2d3b26..f96bd1e8f88 100644 --- a/googleapiclient/discovery_cache/documents/fitness.v1.json +++ b/googleapiclient/discovery_cache/documents/fitness.v1.json @@ -831,7 +831,7 @@ } } }, - "revision": "20220706", + "revision": "20220713", "rootUrl": "https://fitness.googleapis.com/", "schemas": { "AggregateBucket": { diff --git a/googleapiclient/discovery_cache/documents/forms.v1.json b/googleapiclient/discovery_cache/documents/forms.v1.json index ceef6b832fa..753a91694d2 100644 --- a/googleapiclient/discovery_cache/documents/forms.v1.json +++ b/googleapiclient/discovery_cache/documents/forms.v1.json @@ -423,7 +423,7 @@ } } }, - "revision": "20220703", + "revision": "20220714", "rootUrl": "https://forms.googleapis.com/", "schemas": { "Answer": { diff --git a/googleapiclient/discovery_cache/documents/games.v1.json b/googleapiclient/discovery_cache/documents/games.v1.json index e244e01b9f1..17d7797ce3a 100644 --- a/googleapiclient/discovery_cache/documents/games.v1.json +++ b/googleapiclient/discovery_cache/documents/games.v1.json @@ -1244,7 +1244,7 @@ } } }, - "revision": "20220609", + "revision": "20220629", "rootUrl": "https://games.googleapis.com/", "schemas": { "AchievementDefinition": { diff --git a/googleapiclient/discovery_cache/documents/gamesConfiguration.v1configuration.json b/googleapiclient/discovery_cache/documents/gamesConfiguration.v1configuration.json index 220b0727128..05828625188 100644 --- a/googleapiclient/discovery_cache/documents/gamesConfiguration.v1configuration.json +++ b/googleapiclient/discovery_cache/documents/gamesConfiguration.v1configuration.json @@ -439,7 +439,7 @@ } } }, - "revision": "20220609", + "revision": "20220629", "rootUrl": "https://gamesconfiguration.googleapis.com/", "schemas": { "AchievementConfiguration": { diff --git a/googleapiclient/discovery_cache/documents/gamesManagement.v1management.json b/googleapiclient/discovery_cache/documents/gamesManagement.v1management.json index ceef598d9f7..afee9e2b65a 100644 --- a/googleapiclient/discovery_cache/documents/gamesManagement.v1management.json +++ b/googleapiclient/discovery_cache/documents/gamesManagement.v1management.json @@ -471,7 +471,7 @@ } } }, - "revision": "20220609", + "revision": "20220629", "rootUrl": "https://gamesmanagement.googleapis.com/", "schemas": { "AchievementResetAllResponse": { diff --git a/googleapiclient/discovery_cache/documents/gameservices.v1.json b/googleapiclient/discovery_cache/documents/gameservices.v1.json index 9ee59b61b22..fd94bb7d6ff 100644 --- a/googleapiclient/discovery_cache/documents/gameservices.v1.json +++ b/googleapiclient/discovery_cache/documents/gameservices.v1.json @@ -1357,7 +1357,7 @@ } } }, - "revision": "20220623", + "revision": "20220707", "rootUrl": "https://gameservices.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/googleapiclient/discovery_cache/documents/gameservices.v1beta.json b/googleapiclient/discovery_cache/documents/gameservices.v1beta.json index e857aadb15d..befa2c5e1be 100644 --- a/googleapiclient/discovery_cache/documents/gameservices.v1beta.json +++ b/googleapiclient/discovery_cache/documents/gameservices.v1beta.json @@ -1357,7 +1357,7 @@ } } }, - "revision": "20220623", + "revision": "20220707", "rootUrl": "https://gameservices.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/googleapiclient/discovery_cache/documents/genomics.v2alpha1.json b/googleapiclient/discovery_cache/documents/genomics.v2alpha1.json index 13565b541dd..f5ff6e472a9 100644 --- a/googleapiclient/discovery_cache/documents/genomics.v2alpha1.json +++ b/googleapiclient/discovery_cache/documents/genomics.v2alpha1.json @@ -301,7 +301,7 @@ } } }, - "revision": "20220625", + "revision": "20220709", "rootUrl": "https://genomics.googleapis.com/", "schemas": { "Accelerator": { diff --git a/googleapiclient/discovery_cache/documents/gmail.v1.json b/googleapiclient/discovery_cache/documents/gmail.v1.json index ae9d31f447a..3aba5bb2cb9 100644 --- a/googleapiclient/discovery_cache/documents/gmail.v1.json +++ b/googleapiclient/discovery_cache/documents/gmail.v1.json @@ -2682,7 +2682,7 @@ } } }, - "revision": "20220625", + "revision": "20220711", "rootUrl": "https://gmail.googleapis.com/", "schemas": { "AutoForwarding": { diff --git a/googleapiclient/discovery_cache/documents/gmailpostmastertools.v1.json b/googleapiclient/discovery_cache/documents/gmailpostmastertools.v1.json index 122899337d6..bd5cce405c5 100644 --- a/googleapiclient/discovery_cache/documents/gmailpostmastertools.v1.json +++ b/googleapiclient/discovery_cache/documents/gmailpostmastertools.v1.json @@ -265,7 +265,7 @@ } } }, - "revision": "20220708", + "revision": "20220714", "rootUrl": "https://gmailpostmastertools.googleapis.com/", "schemas": { "DeliveryError": { diff --git a/googleapiclient/discovery_cache/documents/gmailpostmastertools.v1beta1.json b/googleapiclient/discovery_cache/documents/gmailpostmastertools.v1beta1.json index cb6200f88e3..a1d66dd612f 100644 --- a/googleapiclient/discovery_cache/documents/gmailpostmastertools.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/gmailpostmastertools.v1beta1.json @@ -265,7 +265,7 @@ } } }, - "revision": "20220708", + "revision": "20220714", "rootUrl": "https://gmailpostmastertools.googleapis.com/", "schemas": { "DeliveryError": { diff --git a/googleapiclient/discovery_cache/documents/healthcare.v1.json b/googleapiclient/discovery_cache/documents/healthcare.v1.json index f0e3d3501d9..1e571ac5d4a 100644 --- a/googleapiclient/discovery_cache/documents/healthcare.v1.json +++ b/googleapiclient/discovery_cache/documents/healthcare.v1.json @@ -4053,7 +4053,7 @@ } } }, - "revision": "20220629", + "revision": "20220705", "rootUrl": "https://healthcare.googleapis.com/", "schemas": { "ActivateConsentRequest": { diff --git a/googleapiclient/discovery_cache/documents/healthcare.v1beta1.json b/googleapiclient/discovery_cache/documents/healthcare.v1beta1.json index 2874ff981f8..c94ac5a5ed7 100644 --- a/googleapiclient/discovery_cache/documents/healthcare.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/healthcare.v1beta1.json @@ -4865,7 +4865,7 @@ } } }, - "revision": "20220629", + "revision": "20220705", "rootUrl": "https://healthcare.googleapis.com/", "schemas": { "ActivateConsentRequest": { diff --git a/googleapiclient/discovery_cache/documents/homegraph.v1.json b/googleapiclient/discovery_cache/documents/homegraph.v1.json index 0c95feb981a..87d2b8da54e 100644 --- a/googleapiclient/discovery_cache/documents/homegraph.v1.json +++ b/googleapiclient/discovery_cache/documents/homegraph.v1.json @@ -216,7 +216,7 @@ } } }, - "revision": "20220629", + "revision": "20220712", "rootUrl": "https://homegraph.googleapis.com/", "schemas": { "AgentDeviceId": { diff --git a/googleapiclient/discovery_cache/documents/iam.v1.json b/googleapiclient/discovery_cache/documents/iam.v1.json index 0357bf4153c..62cc10cfa18 100644 --- a/googleapiclient/discovery_cache/documents/iam.v1.json +++ b/googleapiclient/discovery_cache/documents/iam.v1.json @@ -1921,7 +1921,7 @@ } } }, - "revision": "20220621", + "revision": "20220706", "rootUrl": "https://iam.googleapis.com/", "schemas": { "AdminAuditData": { diff --git a/googleapiclient/discovery_cache/documents/iam.v2beta.json b/googleapiclient/discovery_cache/documents/iam.v2beta.json index 5544c3f2164..f63d4b9b4b6 100644 --- a/googleapiclient/discovery_cache/documents/iam.v2beta.json +++ b/googleapiclient/discovery_cache/documents/iam.v2beta.json @@ -293,7 +293,7 @@ } } }, - "revision": "20220621", + "revision": "20220706", "rootUrl": "https://iam.googleapis.com/", "schemas": { "GoogleIamAdminV1AuditData": { diff --git a/googleapiclient/discovery_cache/documents/iamcredentials.v1.json b/googleapiclient/discovery_cache/documents/iamcredentials.v1.json index efdcadad523..7f72a31f5da 100644 --- a/googleapiclient/discovery_cache/documents/iamcredentials.v1.json +++ b/googleapiclient/discovery_cache/documents/iamcredentials.v1.json @@ -226,7 +226,7 @@ } } }, - "revision": "20220624", + "revision": "20220709", "rootUrl": "https://iamcredentials.googleapis.com/", "schemas": { "GenerateAccessTokenRequest": { diff --git a/googleapiclient/discovery_cache/documents/ideahub.v1alpha.json b/googleapiclient/discovery_cache/documents/ideahub.v1alpha.json index db854a0e528..1731a914f0e 100644 --- a/googleapiclient/discovery_cache/documents/ideahub.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/ideahub.v1alpha.json @@ -331,7 +331,7 @@ } } }, - "revision": "20220708", + "revision": "20220715", "rootUrl": "https://ideahub.googleapis.com/", "schemas": { "GoogleSearchIdeahubV1alphaAvailableLocale": { diff --git a/googleapiclient/discovery_cache/documents/ideahub.v1beta.json b/googleapiclient/discovery_cache/documents/ideahub.v1beta.json index 6df4484c0f8..dd65d087d0d 100644 --- a/googleapiclient/discovery_cache/documents/ideahub.v1beta.json +++ b/googleapiclient/discovery_cache/documents/ideahub.v1beta.json @@ -288,7 +288,7 @@ } } }, - "revision": "20220708", + "revision": "20220715", "rootUrl": "https://ideahub.googleapis.com/", "schemas": { "GoogleSearchIdeahubV1betaAvailableLocale": { diff --git a/googleapiclient/discovery_cache/documents/indexing.v3.json b/googleapiclient/discovery_cache/documents/indexing.v3.json index e01864877ee..c936f966682 100644 --- a/googleapiclient/discovery_cache/documents/indexing.v3.json +++ b/googleapiclient/discovery_cache/documents/indexing.v3.json @@ -149,7 +149,7 @@ } } }, - "revision": "20220628", + "revision": "20220712", "rootUrl": "https://indexing.googleapis.com/", "schemas": { "PublishUrlNotificationResponse": { diff --git a/googleapiclient/discovery_cache/documents/keep.v1.json b/googleapiclient/discovery_cache/documents/keep.v1.json index b09e649aa20..040e37125f9 100644 --- a/googleapiclient/discovery_cache/documents/keep.v1.json +++ b/googleapiclient/discovery_cache/documents/keep.v1.json @@ -314,7 +314,7 @@ } } }, - "revision": "20220703", + "revision": "20220712", "rootUrl": "https://keep.googleapis.com/", "schemas": { "Attachment": { diff --git a/googleapiclient/discovery_cache/documents/kgsearch.v1.json b/googleapiclient/discovery_cache/documents/kgsearch.v1.json index fd5afdbe680..ce29701c785 100644 --- a/googleapiclient/discovery_cache/documents/kgsearch.v1.json +++ b/googleapiclient/discovery_cache/documents/kgsearch.v1.json @@ -151,7 +151,7 @@ } } }, - "revision": "20220708", + "revision": "20220715", "rootUrl": "https://kgsearch.googleapis.com/", "schemas": { "SearchResponse": { diff --git a/googleapiclient/discovery_cache/documents/language.v1.json b/googleapiclient/discovery_cache/documents/language.v1.json index e82f3f10222..dfe3b08b3f1 100644 --- a/googleapiclient/discovery_cache/documents/language.v1.json +++ b/googleapiclient/discovery_cache/documents/language.v1.json @@ -227,7 +227,7 @@ } } }, - "revision": "20220624", + "revision": "20220708", "rootUrl": "https://language.googleapis.com/", "schemas": { "AnalyzeEntitiesRequest": { diff --git a/googleapiclient/discovery_cache/documents/language.v1beta1.json b/googleapiclient/discovery_cache/documents/language.v1beta1.json index 16fb13a067d..5c1472bf328 100644 --- a/googleapiclient/discovery_cache/documents/language.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/language.v1beta1.json @@ -189,7 +189,7 @@ } } }, - "revision": "20220624", + "revision": "20220708", "rootUrl": "https://language.googleapis.com/", "schemas": { "AnalyzeEntitiesRequest": { diff --git a/googleapiclient/discovery_cache/documents/language.v1beta2.json b/googleapiclient/discovery_cache/documents/language.v1beta2.json index a32c1105cbd..5813da7e79c 100644 --- a/googleapiclient/discovery_cache/documents/language.v1beta2.json +++ b/googleapiclient/discovery_cache/documents/language.v1beta2.json @@ -227,7 +227,7 @@ } } }, - "revision": "20220624", + "revision": "20220708", "rootUrl": "https://language.googleapis.com/", "schemas": { "AnalyzeEntitiesRequest": { diff --git a/googleapiclient/discovery_cache/documents/libraryagent.v1.json b/googleapiclient/discovery_cache/documents/libraryagent.v1.json index 3efc858e208..966dee88667 100644 --- a/googleapiclient/discovery_cache/documents/libraryagent.v1.json +++ b/googleapiclient/discovery_cache/documents/libraryagent.v1.json @@ -279,7 +279,7 @@ } } }, - "revision": "20220708", + "revision": "20220715", "rootUrl": "https://libraryagent.googleapis.com/", "schemas": { "GoogleExampleLibraryagentV1Book": { diff --git a/googleapiclient/discovery_cache/documents/licensing.v1.json b/googleapiclient/discovery_cache/documents/licensing.v1.json index 4e07995cf65..ad411cd84fa 100644 --- a/googleapiclient/discovery_cache/documents/licensing.v1.json +++ b/googleapiclient/discovery_cache/documents/licensing.v1.json @@ -400,7 +400,7 @@ } } }, - "revision": "20220709", + "revision": "20220716", "rootUrl": "https://licensing.googleapis.com/", "schemas": { "Empty": { diff --git a/googleapiclient/discovery_cache/documents/localservices.v1.json b/googleapiclient/discovery_cache/documents/localservices.v1.json index 871bb487243..303ede2c55a 100644 --- a/googleapiclient/discovery_cache/documents/localservices.v1.json +++ b/googleapiclient/discovery_cache/documents/localservices.v1.json @@ -250,7 +250,7 @@ } } }, - "revision": "20220708", + "revision": "20220715", "rootUrl": "https://localservices.googleapis.com/", "schemas": { "GoogleAdsHomeservicesLocalservicesV1AccountReport": { diff --git a/googleapiclient/discovery_cache/documents/logging.v2.json b/googleapiclient/discovery_cache/documents/logging.v2.json index ab03377bfae..80eefa581f2 100644 --- a/googleapiclient/discovery_cache/documents/logging.v2.json +++ b/googleapiclient/discovery_cache/documents/logging.v2.json @@ -6007,7 +6007,7 @@ } } }, - "revision": "20220624", + "revision": "20220714", "rootUrl": "https://logging.googleapis.com/", "schemas": { "BigQueryOptions": { @@ -6771,7 +6771,7 @@ "description": "Optional. Source code location information associated with the log entry, if any." }, "spanId": { - "description": "Optional. The span ID within the trace associated with the log entry.For Trace spans, this is the same format that the Trace API v2 uses: a 16-character hexadecimal encoding of an 8-byte array, such as 000000000000004a.", + "description": "Optional. The ID of the Cloud Trace (https://cloud.google.com/trace) span associated with the current operation in which the log is being written. For example, if a span has the REST resource name of \"projects/some-project/traces/some-trace/spans/some-span-id\", then the span_id field is \"some-span-id\".A Span (https://cloud.google.com/trace/docs/reference/v2/rest/v2/projects.traces/batchWrite#Span) represents a single operation within a trace. Whereas a trace may involve multiple different microservices running on multiple different machines, a span generally corresponds to a single logical operation being performed in a single instance of a microservice on one specific machine. Spans are the nodes within the tree that is a trace.Applications that are instrumented for tracing (https://cloud.google.com/trace/docs/setup) will generally assign a new, unique span ID on each incoming request. It is also common to create and record additional spans corresponding to internal processing elements as well as issuing requests to dependencies.The span ID is expected to be a 16-character, hexadecimal encoding of an 8-byte array and should not be zero. It should be unique within the trace and should, ideally, be generated in a manner that is uniformly random.Example values: 000000000000004a 7a2190356c3fc94b 0000f00300090021 d39223e101960076", "type": "string" }, "split": { @@ -6788,7 +6788,7 @@ "type": "string" }, "trace": { - "description": "Optional. Resource name of the trace associated with the log entry, if any. If it contains a relative resource name, the name is assumed to be relative to //tracing.googleapis.com. Example: projects/my-projectid/traces/06796866738c859f2f19b7cfb3214824", + "description": "Optional. The REST resource name of the trace being written to Cloud Trace (https://cloud.google.com/trace) in association with this log entry. For example, if your trace data is stored in the Cloud project \"my-trace-project\" and if the service that is creating the log entry receives a trace header that includes the trace ID \"12345\", then the service should use \"projects/my-tracing-project/traces/12345\".The trace field provides the link between logs and traces. By using this field, you can navigate from a log entry to a trace.", "type": "string" }, "traceSampled": { @@ -7054,7 +7054,7 @@ "type": "string" }, "writerIdentity": { - "description": "Output only. An IAM identity\u2014a service account or group\u2014under which Cloud Logging writes the exported log entries to the sink's destination. This field is set by sinks.create and sinks.update based on the value of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting Access for a Resource (https://cloud.google.com/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.Sinks that have a destination that is a log bucket in the same project as the sink do not have a writer_identity and no additional permissions are required.", + "description": "Output only. An IAM identity\u2014a service account or group\u2014under which Cloud Logging writes the exported log entries to the sink's destination. This field is either set by specifying custom_writer_identity or set automatically by sinks.create and sinks.update based on the value of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting Access for a Resource (https://cloud.google.com/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.Sinks that have a destination that is a log bucket in the same project as the sink cannot have a writer_identity and no additional permissions are required.", "readOnly": true, "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/manufacturers.v1.json b/googleapiclient/discovery_cache/documents/manufacturers.v1.json index d3247a8991a..9043698d62c 100644 --- a/googleapiclient/discovery_cache/documents/manufacturers.v1.json +++ b/googleapiclient/discovery_cache/documents/manufacturers.v1.json @@ -287,7 +287,7 @@ } } }, - "revision": "20220706", + "revision": "20220713", "rootUrl": "https://manufacturers.googleapis.com/", "schemas": { "Attributes": { diff --git a/googleapiclient/discovery_cache/documents/memcache.v1.json b/googleapiclient/discovery_cache/documents/memcache.v1.json index 79b65e00230..7bf96961abf 100644 --- a/googleapiclient/discovery_cache/documents/memcache.v1.json +++ b/googleapiclient/discovery_cache/documents/memcache.v1.json @@ -556,7 +556,7 @@ } } }, - "revision": "20220622", + "revision": "20220709", "rootUrl": "https://memcache.googleapis.com/", "schemas": { "ApplyParametersRequest": { @@ -768,7 +768,7 @@ "additionalProperties": { "type": "string" }, - "description": "Deprecated. The MaintenancePolicies that have been attached to the instance. The key must be of the type name of the oneof policy name defined in MaintenancePolicy, and the referenced policy must define the same policy type. For complete details of MaintenancePolicy, please refer to go/cloud-saas-mw-ug.", + "description": "Optional. Deprecated. The MaintenancePolicies that have been attached to the instance. The key must be of the type name of the oneof policy name defined in MaintenancePolicy, and the referenced policy must define the same policy type. For complete details of MaintenancePolicy, please refer to go/cloud-saas-mw-ug.", "type": "object" }, "maintenanceSchedules": { @@ -908,7 +908,7 @@ "additionalProperties": { "$ref": "MaintenancePolicy" }, - "description": "Optional. The MaintenancePolicies that have been attached to the instance. The key must be of the type name of the oneof policy name defined in MaintenancePolicy, and the embedded policy must define the same policy type. For complete details of MaintenancePolicy, please refer to go/cloud-saas-mw-ug. If only the name is needed (like in the deprecated Instance.maintenance_policy_names field) then only populate MaintenancePolicy.name.", + "description": "Optional. The MaintenancePolicies that have been attached to the instance. The key must be of the type name of the oneof policy name defined in MaintenancePolicy, and the embedded policy must define the same policy type. For complete details of MaintenancePolicy, please refer to go/cloud-saas-mw-ug. If only the name is needed, then only populate MaintenancePolicy.name.", "type": "object" } }, diff --git a/googleapiclient/discovery_cache/documents/memcache.v1beta2.json b/googleapiclient/discovery_cache/documents/memcache.v1beta2.json index 39364b14810..fba10017bfb 100644 --- a/googleapiclient/discovery_cache/documents/memcache.v1beta2.json +++ b/googleapiclient/discovery_cache/documents/memcache.v1beta2.json @@ -584,7 +584,7 @@ } } }, - "revision": "20220622", + "revision": "20220709", "rootUrl": "https://memcache.googleapis.com/", "schemas": { "ApplyParametersRequest": { @@ -814,7 +814,7 @@ "additionalProperties": { "type": "string" }, - "description": "Deprecated. The MaintenancePolicies that have been attached to the instance. The key must be of the type name of the oneof policy name defined in MaintenancePolicy, and the referenced policy must define the same policy type. For complete details of MaintenancePolicy, please refer to go/cloud-saas-mw-ug.", + "description": "Optional. Deprecated. The MaintenancePolicies that have been attached to the instance. The key must be of the type name of the oneof policy name defined in MaintenancePolicy, and the referenced policy must define the same policy type. For complete details of MaintenancePolicy, please refer to go/cloud-saas-mw-ug.", "type": "object" }, "maintenanceSchedules": { @@ -954,7 +954,7 @@ "additionalProperties": { "$ref": "MaintenancePolicy" }, - "description": "Optional. The MaintenancePolicies that have been attached to the instance. The key must be of the type name of the oneof policy name defined in MaintenancePolicy, and the embedded policy must define the same policy type. For complete details of MaintenancePolicy, please refer to go/cloud-saas-mw-ug. If only the name is needed (like in the deprecated Instance.maintenance_policy_names field) then only populate MaintenancePolicy.name.", + "description": "Optional. The MaintenancePolicies that have been attached to the instance. The key must be of the type name of the oneof policy name defined in MaintenancePolicy, and the embedded policy must define the same policy type. For complete details of MaintenancePolicy, please refer to go/cloud-saas-mw-ug. If only the name is needed, then only populate MaintenancePolicy.name.", "type": "object" } }, diff --git a/googleapiclient/discovery_cache/documents/metastore.v1alpha.json b/googleapiclient/discovery_cache/documents/metastore.v1alpha.json index 3d0f123c229..f1850dfc45a 100644 --- a/googleapiclient/discovery_cache/documents/metastore.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/metastore.v1alpha.json @@ -1467,7 +1467,7 @@ } } }, - "revision": "20220706", + "revision": "20220711", "rootUrl": "https://metastore.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/googleapiclient/discovery_cache/documents/metastore.v1beta.json b/googleapiclient/discovery_cache/documents/metastore.v1beta.json index 48c08a10ff6..c9f121460a5 100644 --- a/googleapiclient/discovery_cache/documents/metastore.v1beta.json +++ b/googleapiclient/discovery_cache/documents/metastore.v1beta.json @@ -1467,7 +1467,7 @@ } } }, - "revision": "20220706", + "revision": "20220711", "rootUrl": "https://metastore.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/googleapiclient/discovery_cache/documents/ml.v1.json b/googleapiclient/discovery_cache/documents/ml.v1.json index eba40615e1e..73308219049 100644 --- a/googleapiclient/discovery_cache/documents/ml.v1.json +++ b/googleapiclient/discovery_cache/documents/ml.v1.json @@ -1486,7 +1486,7 @@ } } }, - "revision": "20220701", + "revision": "20220708", "rootUrl": "https://ml.googleapis.com/", "schemas": { "GoogleApi__HttpBody": { diff --git a/googleapiclient/discovery_cache/documents/monitoring.v1.json b/googleapiclient/discovery_cache/documents/monitoring.v1.json index df8bcb3b81c..d976bbe064f 100644 --- a/googleapiclient/discovery_cache/documents/monitoring.v1.json +++ b/googleapiclient/discovery_cache/documents/monitoring.v1.json @@ -769,7 +769,7 @@ } } }, - "revision": "20220704", + "revision": "20220713", "rootUrl": "https://monitoring.googleapis.com/", "schemas": { "Aggregation": { diff --git a/googleapiclient/discovery_cache/documents/monitoring.v3.json b/googleapiclient/discovery_cache/documents/monitoring.v3.json index 85456ea8f8b..bd2f37ef75b 100644 --- a/googleapiclient/discovery_cache/documents/monitoring.v3.json +++ b/googleapiclient/discovery_cache/documents/monitoring.v3.json @@ -2571,7 +2571,7 @@ } } }, - "revision": "20220704", + "revision": "20220713", "rootUrl": "https://monitoring.googleapis.com/", "schemas": { "Aggregation": { diff --git a/googleapiclient/discovery_cache/documents/mybusinessbusinesscalls.v1.json b/googleapiclient/discovery_cache/documents/mybusinessbusinesscalls.v1.json index 74f5b9bb65f..adc64aa5c58 100644 --- a/googleapiclient/discovery_cache/documents/mybusinessbusinesscalls.v1.json +++ b/googleapiclient/discovery_cache/documents/mybusinessbusinesscalls.v1.json @@ -198,7 +198,7 @@ } } }, - "revision": "20220708", + "revision": "20220716", "rootUrl": "https://mybusinessbusinesscalls.googleapis.com/", "schemas": { "AggregateMetrics": { diff --git a/googleapiclient/discovery_cache/documents/mybusinessbusinessinformation.v1.json b/googleapiclient/discovery_cache/documents/mybusinessbusinessinformation.v1.json index f392397c496..a2e04fdcabe 100644 --- a/googleapiclient/discovery_cache/documents/mybusinessbusinessinformation.v1.json +++ b/googleapiclient/discovery_cache/documents/mybusinessbusinessinformation.v1.json @@ -662,7 +662,7 @@ } } }, - "revision": "20220708", + "revision": "20220716", "rootUrl": "https://mybusinessbusinessinformation.googleapis.com/", "schemas": { "AdWordsLocationExtensions": { diff --git a/googleapiclient/discovery_cache/documents/mybusinesslodging.v1.json b/googleapiclient/discovery_cache/documents/mybusinesslodging.v1.json index 31ba5e91439..18451592016 100644 --- a/googleapiclient/discovery_cache/documents/mybusinesslodging.v1.json +++ b/googleapiclient/discovery_cache/documents/mybusinesslodging.v1.json @@ -194,7 +194,7 @@ } } }, - "revision": "20220708", + "revision": "20220716", "rootUrl": "https://mybusinesslodging.googleapis.com/", "schemas": { "Accessibility": { diff --git a/googleapiclient/discovery_cache/documents/mybusinessnotifications.v1.json b/googleapiclient/discovery_cache/documents/mybusinessnotifications.v1.json index 5c1a33e6fcd..abb3a8d95ca 100644 --- a/googleapiclient/discovery_cache/documents/mybusinessnotifications.v1.json +++ b/googleapiclient/discovery_cache/documents/mybusinessnotifications.v1.json @@ -154,7 +154,7 @@ } } }, - "revision": "20220708", + "revision": "20220716", "rootUrl": "https://mybusinessnotifications.googleapis.com/", "schemas": { "NotificationSetting": { diff --git a/googleapiclient/discovery_cache/documents/mybusinessplaceactions.v1.json b/googleapiclient/discovery_cache/documents/mybusinessplaceactions.v1.json index 6e6ba422567..710cf1b0e62 100644 --- a/googleapiclient/discovery_cache/documents/mybusinessplaceactions.v1.json +++ b/googleapiclient/discovery_cache/documents/mybusinessplaceactions.v1.json @@ -281,7 +281,7 @@ } } }, - "revision": "20220708", + "revision": "20220716", "rootUrl": "https://mybusinessplaceactions.googleapis.com/", "schemas": { "Empty": { diff --git a/googleapiclient/discovery_cache/documents/mybusinessqanda.v1.json b/googleapiclient/discovery_cache/documents/mybusinessqanda.v1.json index ce9bcf0d7a5..0b9d2931555 100644 --- a/googleapiclient/discovery_cache/documents/mybusinessqanda.v1.json +++ b/googleapiclient/discovery_cache/documents/mybusinessqanda.v1.json @@ -323,7 +323,7 @@ } } }, - "revision": "20220708", + "revision": "20220716", "rootUrl": "https://mybusinessqanda.googleapis.com/", "schemas": { "Answer": { diff --git a/googleapiclient/discovery_cache/documents/mybusinessverifications.v1.json b/googleapiclient/discovery_cache/documents/mybusinessverifications.v1.json index 9da584e3c75..e8519eed782 100644 --- a/googleapiclient/discovery_cache/documents/mybusinessverifications.v1.json +++ b/googleapiclient/discovery_cache/documents/mybusinessverifications.v1.json @@ -256,7 +256,7 @@ } } }, - "revision": "20220708", + "revision": "20220716", "rootUrl": "https://mybusinessverifications.googleapis.com/", "schemas": { "AddressVerificationData": { diff --git a/googleapiclient/discovery_cache/documents/networkmanagement.v1.json b/googleapiclient/discovery_cache/documents/networkmanagement.v1.json index 494e38d96f8..42a96d00fa4 100644 --- a/googleapiclient/discovery_cache/documents/networkmanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/networkmanagement.v1.json @@ -591,7 +591,7 @@ } } }, - "revision": "20220706", + "revision": "20220707", "rootUrl": "https://networkmanagement.googleapis.com/", "schemas": { "AbortInfo": { diff --git a/googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json b/googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json index 947bf5c0cc6..4e67cee9de6 100644 --- a/googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json @@ -591,7 +591,7 @@ } } }, - "revision": "20220706", + "revision": "20220707", "rootUrl": "https://networkmanagement.googleapis.com/", "schemas": { "AbortInfo": { diff --git a/googleapiclient/discovery_cache/documents/networksecurity.v1.json b/googleapiclient/discovery_cache/documents/networksecurity.v1.json index aca948b28df..4fa938fe83c 100644 --- a/googleapiclient/discovery_cache/documents/networksecurity.v1.json +++ b/googleapiclient/discovery_cache/documents/networksecurity.v1.json @@ -1037,7 +1037,7 @@ } } }, - "revision": "20220622", + "revision": "20220707", "rootUrl": "https://networksecurity.googleapis.com/", "schemas": { "AuthorizationPolicy": { @@ -1166,7 +1166,7 @@ "id": "Destination", "properties": { "hosts": { - "description": "Required. List of host names to match. Matched against the \":authority\" header in http requests. At least one host should match. Each host can be an exact match, or a prefix match (example \"mydomain.*\") or a suffix match (example // *.myorg.com\") or a presence(any) match \"*\".", + "description": "Required. List of host names to match. Matched against the \":authority\" header in http requests. At least one host should match. Each host can be an exact match, or a prefix match (example \"mydomain.*\") or a suffix match (example \"*.myorg.com\") or a presence (any) match \"*\".", "items": { "type": "string" }, @@ -1243,7 +1243,7 @@ "id": "GoogleCloudNetworksecurityV1GrpcEndpoint", "properties": { "targetUri": { - "description": "Required. The target URI of the gRPC endpoint. Only UDS path is supported, and should start with \u201cunix:\u201d.", + "description": "Required. The target URI of the gRPC endpoint. Only UDS path is supported, and should start with \"unix:\".", "type": "string" } }, @@ -1395,7 +1395,7 @@ "type": "object" }, "HttpHeaderMatch": { - "description": "Specification of HTTP header match atrributes.", + "description": "Specification of HTTP header match attributes.", "id": "HttpHeaderMatch", "properties": { "headerName": { @@ -1705,7 +1705,7 @@ "type": "array" }, "principals": { - "description": "Optional. List of peer identities to match for authorization. At least one principal should match. Each peer can be an exact match, or a prefix match (example, \"namespace/*\") or a suffix match (example, // */service-account\") or a presence match \"*\". Authorization based on the principal name without certificate validation (configured by ServerTlsPolicy resource) is considered insecure.", + "description": "Optional. List of peer identities to match for authorization. At least one principal should match. Each peer can be an exact match, or a prefix match (example, \"namespace/*\") or a suffix match (example, \"*/service-account\") or a presence match \"*\". Authorization based on the principal name without certificate validation (configured by ServerTlsPolicy resource) is considered insecure.", "items": { "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/networksecurity.v1beta1.json b/googleapiclient/discovery_cache/documents/networksecurity.v1beta1.json index ca9fecdbaf8..5fddcd553e2 100644 --- a/googleapiclient/discovery_cache/documents/networksecurity.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/networksecurity.v1beta1.json @@ -1037,7 +1037,7 @@ } } }, - "revision": "20220622", + "revision": "20220707", "rootUrl": "https://networksecurity.googleapis.com/", "schemas": { "AuthorizationPolicy": { @@ -1166,7 +1166,7 @@ "id": "Destination", "properties": { "hosts": { - "description": "Required. List of host names to match. Matched against the \":authority\" header in http requests. At least one host should match. Each host can be an exact match, or a prefix match (example \"mydomain.*\") or a suffix match (example // *.myorg.com\") or a presence(any) match \"*\".", + "description": "Required. List of host names to match. Matched against the \":authority\" header in http requests. At least one host should match. Each host can be an exact match, or a prefix match (example \"mydomain.*\") or a suffix match (example \"*.myorg.com\") or a presence (any) match \"*\".", "items": { "type": "string" }, @@ -1243,7 +1243,7 @@ "id": "GoogleCloudNetworksecurityV1beta1GrpcEndpoint", "properties": { "targetUri": { - "description": "Required. The target URI of the gRPC endpoint. Only UDS path is supported, and should start with \u201cunix:\u201d.", + "description": "Required. The target URI of the gRPC endpoint. Only UDS path is supported, and should start with \"unix:\".", "type": "string" } }, @@ -1395,7 +1395,7 @@ "type": "object" }, "HttpHeaderMatch": { - "description": "Specification of HTTP header match atrributes.", + "description": "Specification of HTTP header match attributes.", "id": "HttpHeaderMatch", "properties": { "headerName": { @@ -1705,7 +1705,7 @@ "type": "array" }, "principals": { - "description": "Optional. List of peer identities to match for authorization. At least one principal should match. Each peer can be an exact match, or a prefix match (example, \"namespace/*\") or a suffix match (example, // */service-account\") or a presence match \"*\". Authorization based on the principal name without certificate validation (configured by ServerTlsPolicy resource) is considered insecure.", + "description": "Optional. List of peer identities to match for authorization. At least one principal should match. Each peer can be an exact match, or a prefix match (example, \"namespace/*\") or a suffix match (example, \"*/service-account\") or a presence match \"*\". Authorization based on the principal name without certificate validation (configured by ServerTlsPolicy resource) is considered insecure.", "items": { "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/networkservices.v1.json b/googleapiclient/discovery_cache/documents/networkservices.v1.json index 4b803a96825..35d5c3cb2ce 100644 --- a/googleapiclient/discovery_cache/documents/networkservices.v1.json +++ b/googleapiclient/discovery_cache/documents/networkservices.v1.json @@ -2148,7 +2148,7 @@ } } }, - "revision": "20220623", + "revision": "20220707", "rootUrl": "https://networkservices.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/googleapiclient/discovery_cache/documents/networkservices.v1beta1.json b/googleapiclient/discovery_cache/documents/networkservices.v1beta1.json index 297280f2bc4..044378a2494 100644 --- a/googleapiclient/discovery_cache/documents/networkservices.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/networkservices.v1beta1.json @@ -1875,7 +1875,7 @@ } } }, - "revision": "20220623", + "revision": "20220707", "rootUrl": "https://networkservices.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/googleapiclient/discovery_cache/documents/orgpolicy.v2.json b/googleapiclient/discovery_cache/documents/orgpolicy.v2.json index b7c2997b2ab..b2187776d87 100644 --- a/googleapiclient/discovery_cache/documents/orgpolicy.v2.json +++ b/googleapiclient/discovery_cache/documents/orgpolicy.v2.json @@ -751,7 +751,7 @@ } } }, - "revision": "20220708", + "revision": "20220715", "rootUrl": "https://orgpolicy.googleapis.com/", "schemas": { "GoogleCloudOrgpolicyV2AlternatePolicySpec": { diff --git a/googleapiclient/discovery_cache/documents/oslogin.v1.json b/googleapiclient/discovery_cache/documents/oslogin.v1.json index 63c4dd6e17b..8d3e6000e91 100644 --- a/googleapiclient/discovery_cache/documents/oslogin.v1.json +++ b/googleapiclient/discovery_cache/documents/oslogin.v1.json @@ -343,7 +343,7 @@ } } }, - "revision": "20220627", + "revision": "20220708", "rootUrl": "https://oslogin.googleapis.com/", "schemas": { "Empty": { diff --git a/googleapiclient/discovery_cache/documents/oslogin.v1alpha.json b/googleapiclient/discovery_cache/documents/oslogin.v1alpha.json index b42dbdf33c3..2ae444715e2 100644 --- a/googleapiclient/discovery_cache/documents/oslogin.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/oslogin.v1alpha.json @@ -403,7 +403,7 @@ } } }, - "revision": "20220627", + "revision": "20220708", "rootUrl": "https://oslogin.googleapis.com/", "schemas": { "Empty": { diff --git a/googleapiclient/discovery_cache/documents/oslogin.v1beta.json b/googleapiclient/discovery_cache/documents/oslogin.v1beta.json index e84a9129f6a..fa3c59ed56a 100644 --- a/googleapiclient/discovery_cache/documents/oslogin.v1beta.json +++ b/googleapiclient/discovery_cache/documents/oslogin.v1beta.json @@ -373,7 +373,7 @@ } } }, - "revision": "20220627", + "revision": "20220708", "rootUrl": "https://oslogin.googleapis.com/", "schemas": { "Empty": { diff --git a/googleapiclient/discovery_cache/documents/pagespeedonline.v5.json b/googleapiclient/discovery_cache/documents/pagespeedonline.v5.json index 90ff71bdbf2..178b5e1511f 100644 --- a/googleapiclient/discovery_cache/documents/pagespeedonline.v5.json +++ b/googleapiclient/discovery_cache/documents/pagespeedonline.v5.json @@ -193,7 +193,7 @@ } } }, - "revision": "20220707", + "revision": "20220714", "rootUrl": "https://pagespeedonline.googleapis.com/", "schemas": { "AuditRefs": { diff --git a/googleapiclient/discovery_cache/documents/paymentsresellersubscription.v1.json b/googleapiclient/discovery_cache/documents/paymentsresellersubscription.v1.json index 041fda03184..ef2ed8fa8cd 100644 --- a/googleapiclient/discovery_cache/documents/paymentsresellersubscription.v1.json +++ b/googleapiclient/discovery_cache/documents/paymentsresellersubscription.v1.json @@ -396,7 +396,7 @@ } } }, - "revision": "20220710", + "revision": "20220717", "rootUrl": "https://paymentsresellersubscription.googleapis.com/", "schemas": { "GoogleCloudPaymentsResellerSubscriptionV1CancelSubscriptionRequest": { diff --git a/googleapiclient/discovery_cache/documents/people.v1.json b/googleapiclient/discovery_cache/documents/people.v1.json index 0828f2464e6..dd8bc0d9fda 100644 --- a/googleapiclient/discovery_cache/documents/people.v1.json +++ b/googleapiclient/discovery_cache/documents/people.v1.json @@ -1172,7 +1172,7 @@ } } }, - "revision": "20220707", + "revision": "20220714", "rootUrl": "https://people.googleapis.com/", "schemas": { "Address": { diff --git a/googleapiclient/discovery_cache/documents/playcustomapp.v1.json b/googleapiclient/discovery_cache/documents/playcustomapp.v1.json index cd7544ca8ea..a8d8e567323 100644 --- a/googleapiclient/discovery_cache/documents/playcustomapp.v1.json +++ b/googleapiclient/discovery_cache/documents/playcustomapp.v1.json @@ -158,7 +158,7 @@ } } }, - "revision": "20220708", + "revision": "20220715", "rootUrl": "https://playcustomapp.googleapis.com/", "schemas": { "CustomApp": { diff --git a/googleapiclient/discovery_cache/documents/playdeveloperreporting.v1alpha1.json b/googleapiclient/discovery_cache/documents/playdeveloperreporting.v1alpha1.json index 0a776162aa8..075321808c7 100644 --- a/googleapiclient/discovery_cache/documents/playdeveloperreporting.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/playdeveloperreporting.v1alpha1.json @@ -718,7 +718,7 @@ } } }, - "revision": "20220708", + "revision": "20220715", "rootUrl": "https://playdeveloperreporting.googleapis.com/", "schemas": { "GooglePlayDeveloperReportingV1alpha1Anomaly": { diff --git a/googleapiclient/discovery_cache/documents/playdeveloperreporting.v1beta1.json b/googleapiclient/discovery_cache/documents/playdeveloperreporting.v1beta1.json index 5fb93900b83..29b83a6288a 100644 --- a/googleapiclient/discovery_cache/documents/playdeveloperreporting.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/playdeveloperreporting.v1beta1.json @@ -347,7 +347,7 @@ } } }, - "revision": "20220708", + "revision": "20220715", "rootUrl": "https://playdeveloperreporting.googleapis.com/", "schemas": { "GooglePlayDeveloperReportingV1beta1Anomaly": { diff --git a/googleapiclient/discovery_cache/documents/playintegrity.v1.json b/googleapiclient/discovery_cache/documents/playintegrity.v1.json index 2d812f48598..22b1ec7fb97 100644 --- a/googleapiclient/discovery_cache/documents/playintegrity.v1.json +++ b/googleapiclient/discovery_cache/documents/playintegrity.v1.json @@ -138,7 +138,7 @@ } } }, - "revision": "20220708", + "revision": "20220715", "rootUrl": "https://playintegrity.googleapis.com/", "schemas": { "AccountDetails": { diff --git a/googleapiclient/discovery_cache/documents/policyanalyzer.v1.json b/googleapiclient/discovery_cache/documents/policyanalyzer.v1.json index 6b0045882e3..ba8fe79b168 100644 --- a/googleapiclient/discovery_cache/documents/policyanalyzer.v1.json +++ b/googleapiclient/discovery_cache/documents/policyanalyzer.v1.json @@ -163,7 +163,7 @@ } } }, - "revision": "20220708", + "revision": "20220715", "rootUrl": "https://policyanalyzer.googleapis.com/", "schemas": { "GoogleCloudPolicyanalyzerV1Activity": { diff --git a/googleapiclient/discovery_cache/documents/policyanalyzer.v1beta1.json b/googleapiclient/discovery_cache/documents/policyanalyzer.v1beta1.json index cb3b63c03cb..b8280d5fb0e 100644 --- a/googleapiclient/discovery_cache/documents/policyanalyzer.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/policyanalyzer.v1beta1.json @@ -163,7 +163,7 @@ } } }, - "revision": "20220708", + "revision": "20220715", "rootUrl": "https://policyanalyzer.googleapis.com/", "schemas": { "GoogleCloudPolicyanalyzerV1beta1Activity": { diff --git a/googleapiclient/discovery_cache/documents/policytroubleshooter.v1.json b/googleapiclient/discovery_cache/documents/policytroubleshooter.v1.json index 1c008a9be67..62544e4ee1b 100644 --- a/googleapiclient/discovery_cache/documents/policytroubleshooter.v1.json +++ b/googleapiclient/discovery_cache/documents/policytroubleshooter.v1.json @@ -128,7 +128,7 @@ } } }, - "revision": "20220708", + "revision": "20220715", "rootUrl": "https://policytroubleshooter.googleapis.com/", "schemas": { "GoogleCloudPolicytroubleshooterV1AccessTuple": { diff --git a/googleapiclient/discovery_cache/documents/policytroubleshooter.v1beta.json b/googleapiclient/discovery_cache/documents/policytroubleshooter.v1beta.json index 16f9a2ea518..299b927f079 100644 --- a/googleapiclient/discovery_cache/documents/policytroubleshooter.v1beta.json +++ b/googleapiclient/discovery_cache/documents/policytroubleshooter.v1beta.json @@ -128,7 +128,7 @@ } } }, - "revision": "20220708", + "revision": "20220715", "rootUrl": "https://policytroubleshooter.googleapis.com/", "schemas": { "GoogleCloudPolicytroubleshooterV1betaAccessTuple": { diff --git a/googleapiclient/discovery_cache/documents/prod_tt_sasportal.v1alpha1.json b/googleapiclient/discovery_cache/documents/prod_tt_sasportal.v1alpha1.json index 5f6bb53d58c..d688a81ca12 100644 --- a/googleapiclient/discovery_cache/documents/prod_tt_sasportal.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/prod_tt_sasportal.v1alpha1.json @@ -2564,7 +2564,7 @@ } } }, - "revision": "20220708", + "revision": "20220715", "rootUrl": "https://prod-tt-sasportal.googleapis.com/", "schemas": { "SasPortalAssignment": { diff --git a/googleapiclient/discovery_cache/documents/pubsub.v1.json b/googleapiclient/discovery_cache/documents/pubsub.v1.json index 8e85568910e..8d41e1a5f8a 100644 --- a/googleapiclient/discovery_cache/documents/pubsub.v1.json +++ b/googleapiclient/discovery_cache/documents/pubsub.v1.json @@ -1424,7 +1424,7 @@ } } }, - "revision": "20220628", + "revision": "20220714", "rootUrl": "https://pubsub.googleapis.com/", "schemas": { "AcknowledgeRequest": { diff --git a/googleapiclient/discovery_cache/documents/pubsub.v1beta1a.json b/googleapiclient/discovery_cache/documents/pubsub.v1beta1a.json index 694d1254431..369a1f87a3b 100644 --- a/googleapiclient/discovery_cache/documents/pubsub.v1beta1a.json +++ b/googleapiclient/discovery_cache/documents/pubsub.v1beta1a.json @@ -457,7 +457,7 @@ } } }, - "revision": "20220628", + "revision": "20220714", "rootUrl": "https://pubsub.googleapis.com/", "schemas": { "AcknowledgeRequest": { diff --git a/googleapiclient/discovery_cache/documents/pubsub.v1beta2.json b/googleapiclient/discovery_cache/documents/pubsub.v1beta2.json index f9b734dda65..2b39818f548 100644 --- a/googleapiclient/discovery_cache/documents/pubsub.v1beta2.json +++ b/googleapiclient/discovery_cache/documents/pubsub.v1beta2.json @@ -724,7 +724,7 @@ } } }, - "revision": "20220628", + "revision": "20220714", "rootUrl": "https://pubsub.googleapis.com/", "schemas": { "AcknowledgeRequest": { diff --git a/googleapiclient/discovery_cache/documents/pubsublite.v1.json b/googleapiclient/discovery_cache/documents/pubsublite.v1.json index 73f50688b3b..bc6c18966d7 100644 --- a/googleapiclient/discovery_cache/documents/pubsublite.v1.json +++ b/googleapiclient/discovery_cache/documents/pubsublite.v1.json @@ -1040,7 +1040,7 @@ } } }, - "revision": "20220701", + "revision": "20220712", "rootUrl": "https://pubsublite.googleapis.com/", "schemas": { "CancelOperationRequest": { diff --git a/googleapiclient/discovery_cache/documents/realtimebidding.v1.json b/googleapiclient/discovery_cache/documents/realtimebidding.v1.json index c64199ef9f3..16f6f877152 100644 --- a/googleapiclient/discovery_cache/documents/realtimebidding.v1.json +++ b/googleapiclient/discovery_cache/documents/realtimebidding.v1.json @@ -1305,7 +1305,7 @@ } } }, - "revision": "20220708", + "revision": "20220716", "rootUrl": "https://realtimebidding.googleapis.com/", "schemas": { "ActivatePretargetingConfigRequest": { diff --git a/googleapiclient/discovery_cache/documents/realtimebidding.v1alpha.json b/googleapiclient/discovery_cache/documents/realtimebidding.v1alpha.json index 6bba8c45fff..f87f75b3037 100644 --- a/googleapiclient/discovery_cache/documents/realtimebidding.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/realtimebidding.v1alpha.json @@ -234,7 +234,7 @@ } } }, - "revision": "20220708", + "revision": "20220716", "rootUrl": "https://realtimebidding.googleapis.com/", "schemas": { "ActivateBiddingFunctionRequest": { diff --git a/googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json b/googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json index a5d813515a9..a41edb60168 100644 --- a/googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json +++ b/googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json @@ -514,7 +514,7 @@ } } }, - "revision": "20220701", + "revision": "20220708", "rootUrl": "https://recaptchaenterprise.googleapis.com/", "schemas": { "GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessment": { diff --git a/googleapiclient/discovery_cache/documents/recommendationengine.v1beta1.json b/googleapiclient/discovery_cache/documents/recommendationengine.v1beta1.json index e3163bc2333..40e40848ebc 100644 --- a/googleapiclient/discovery_cache/documents/recommendationengine.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/recommendationengine.v1beta1.json @@ -841,7 +841,7 @@ } } }, - "revision": "20220623", + "revision": "20220707", "rootUrl": "https://recommendationengine.googleapis.com/", "schemas": { "GoogleApiHttpBody": { diff --git a/googleapiclient/discovery_cache/documents/recommender.v1.json b/googleapiclient/discovery_cache/documents/recommender.v1.json index c52e25633be..bb8d6419bcb 100644 --- a/googleapiclient/discovery_cache/documents/recommender.v1.json +++ b/googleapiclient/discovery_cache/documents/recommender.v1.json @@ -1442,7 +1442,7 @@ } } }, - "revision": "20220626", + "revision": "20220710", "rootUrl": "https://recommender.googleapis.com/", "schemas": { "GoogleCloudRecommenderV1CostProjection": { diff --git a/googleapiclient/discovery_cache/documents/recommender.v1beta1.json b/googleapiclient/discovery_cache/documents/recommender.v1beta1.json index 4aa4b8b8c02..2ce0d8d1eb1 100644 --- a/googleapiclient/discovery_cache/documents/recommender.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/recommender.v1beta1.json @@ -1442,7 +1442,7 @@ } } }, - "revision": "20220626", + "revision": "20220710", "rootUrl": "https://recommender.googleapis.com/", "schemas": { "GoogleCloudRecommenderV1beta1CostProjection": { diff --git a/googleapiclient/discovery_cache/documents/redis.v1.json b/googleapiclient/discovery_cache/documents/redis.v1.json index 3244c12c397..1b099882f17 100644 --- a/googleapiclient/discovery_cache/documents/redis.v1.json +++ b/googleapiclient/discovery_cache/documents/redis.v1.json @@ -624,7 +624,7 @@ } } }, - "revision": "20220627", + "revision": "20220707", "rootUrl": "https://redis.googleapis.com/", "schemas": { "Empty": { diff --git a/googleapiclient/discovery_cache/documents/redis.v1beta1.json b/googleapiclient/discovery_cache/documents/redis.v1beta1.json index 403561cce7c..f6fb8a5220a 100644 --- a/googleapiclient/discovery_cache/documents/redis.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/redis.v1beta1.json @@ -624,7 +624,7 @@ } } }, - "revision": "20220627", + "revision": "20220707", "rootUrl": "https://redis.googleapis.com/", "schemas": { "Empty": { diff --git a/googleapiclient/discovery_cache/documents/reseller.v1.json b/googleapiclient/discovery_cache/documents/reseller.v1.json index d288ffc0d18..d07dbb14e8d 100644 --- a/googleapiclient/discovery_cache/documents/reseller.v1.json +++ b/googleapiclient/discovery_cache/documents/reseller.v1.json @@ -631,7 +631,7 @@ } } }, - "revision": "20220705", + "revision": "20220717", "rootUrl": "https://reseller.googleapis.com/", "schemas": { "Address": { diff --git a/googleapiclient/discovery_cache/documents/resourcesettings.v1.json b/googleapiclient/discovery_cache/documents/resourcesettings.v1.json index 9a50e9b3258..635582100c7 100644 --- a/googleapiclient/discovery_cache/documents/resourcesettings.v1.json +++ b/googleapiclient/discovery_cache/documents/resourcesettings.v1.json @@ -499,7 +499,7 @@ } } }, - "revision": "20220708", + "revision": "20220715", "rootUrl": "https://resourcesettings.googleapis.com/", "schemas": { "GoogleCloudResourcesettingsV1ListSettingsResponse": { diff --git a/googleapiclient/discovery_cache/documents/runtimeconfig.v1.json b/googleapiclient/discovery_cache/documents/runtimeconfig.v1.json index a63c5788497..12a5e4a492c 100644 --- a/googleapiclient/discovery_cache/documents/runtimeconfig.v1.json +++ b/googleapiclient/discovery_cache/documents/runtimeconfig.v1.json @@ -210,7 +210,7 @@ } } }, - "revision": "20220613", + "revision": "20220718", "rootUrl": "https://runtimeconfig.googleapis.com/", "schemas": { "CancelOperationRequest": { diff --git a/googleapiclient/discovery_cache/documents/safebrowsing.v4.json b/googleapiclient/discovery_cache/documents/safebrowsing.v4.json index 31c98da4164..fdb3121ed92 100644 --- a/googleapiclient/discovery_cache/documents/safebrowsing.v4.json +++ b/googleapiclient/discovery_cache/documents/safebrowsing.v4.json @@ -261,7 +261,7 @@ } } }, - "revision": "20220708", + "revision": "20220715", "rootUrl": "https://safebrowsing.googleapis.com/", "schemas": { "GoogleProtobufEmpty": { diff --git a/googleapiclient/discovery_cache/documents/sasportal.v1alpha1.json b/googleapiclient/discovery_cache/documents/sasportal.v1alpha1.json index 7b0f704ff27..7d5aa85a316 100644 --- a/googleapiclient/discovery_cache/documents/sasportal.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/sasportal.v1alpha1.json @@ -2563,7 +2563,7 @@ } } }, - "revision": "20220706", + "revision": "20220714", "rootUrl": "https://sasportal.googleapis.com/", "schemas": { "SasPortalAssignment": { diff --git a/googleapiclient/discovery_cache/documents/script.v1.json b/googleapiclient/discovery_cache/documents/script.v1.json index 24487735f55..b2eb21b831e 100644 --- a/googleapiclient/discovery_cache/documents/script.v1.json +++ b/googleapiclient/discovery_cache/documents/script.v1.json @@ -887,7 +887,7 @@ } } }, - "revision": "20220701", + "revision": "20220708", "rootUrl": "https://script.googleapis.com/", "schemas": { "Content": { diff --git a/googleapiclient/discovery_cache/documents/searchconsole.v1.json b/googleapiclient/discovery_cache/documents/searchconsole.v1.json index 1e26e39a5e1..63f3ced1eca 100644 --- a/googleapiclient/discovery_cache/documents/searchconsole.v1.json +++ b/googleapiclient/discovery_cache/documents/searchconsole.v1.json @@ -400,7 +400,7 @@ } } }, - "revision": "20220708", + "revision": "20220715", "rootUrl": "https://searchconsole.googleapis.com/", "schemas": { "AmpInspectionResult": { diff --git a/googleapiclient/discovery_cache/documents/secretmanager.v1.json b/googleapiclient/discovery_cache/documents/secretmanager.v1.json index a57caafe452..8f863035229 100644 --- a/googleapiclient/discovery_cache/documents/secretmanager.v1.json +++ b/googleapiclient/discovery_cache/documents/secretmanager.v1.json @@ -643,7 +643,7 @@ } } }, - "revision": "20220701", + "revision": "20220708", "rootUrl": "https://secretmanager.googleapis.com/", "schemas": { "AccessSecretVersionResponse": { diff --git a/googleapiclient/discovery_cache/documents/secretmanager.v1beta1.json b/googleapiclient/discovery_cache/documents/secretmanager.v1beta1.json index 10e174cfd83..001cf81cd6e 100644 --- a/googleapiclient/discovery_cache/documents/secretmanager.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/secretmanager.v1beta1.json @@ -628,7 +628,7 @@ } } }, - "revision": "20220701", + "revision": "20220708", "rootUrl": "https://secretmanager.googleapis.com/", "schemas": { "AccessSecretVersionResponse": { diff --git a/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1.json b/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1.json index 775f4940963..bd408a16248 100644 --- a/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1.json @@ -542,7 +542,7 @@ } } }, - "revision": "20220706", + "revision": "20220715", "rootUrl": "https://serviceconsumermanagement.googleapis.com/", "schemas": { "AddTenantProjectRequest": { diff --git a/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1beta1.json b/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1beta1.json index c1cea303e3d..956310a3edf 100644 --- a/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1beta1.json @@ -500,7 +500,7 @@ } } }, - "revision": "20220706", + "revision": "20220715", "rootUrl": "https://serviceconsumermanagement.googleapis.com/", "schemas": { "Api": { diff --git a/googleapiclient/discovery_cache/documents/servicecontrol.v1.json b/googleapiclient/discovery_cache/documents/servicecontrol.v1.json index e5853ab590b..33ec8239ced 100644 --- a/googleapiclient/discovery_cache/documents/servicecontrol.v1.json +++ b/googleapiclient/discovery_cache/documents/servicecontrol.v1.json @@ -197,7 +197,7 @@ } } }, - "revision": "20220617", + "revision": "20220707", "rootUrl": "https://servicecontrol.googleapis.com/", "schemas": { "AllocateInfo": { diff --git a/googleapiclient/discovery_cache/documents/servicecontrol.v2.json b/googleapiclient/discovery_cache/documents/servicecontrol.v2.json index 73688d86f03..40785f52187 100644 --- a/googleapiclient/discovery_cache/documents/servicecontrol.v2.json +++ b/googleapiclient/discovery_cache/documents/servicecontrol.v2.json @@ -169,7 +169,7 @@ } } }, - "revision": "20220617", + "revision": "20220707", "rootUrl": "https://servicecontrol.googleapis.com/", "schemas": { "Api": { diff --git a/googleapiclient/discovery_cache/documents/servicedirectory.v1.json b/googleapiclient/discovery_cache/documents/servicedirectory.v1.json index 7bb44162146..7f20fe555c2 100644 --- a/googleapiclient/discovery_cache/documents/servicedirectory.v1.json +++ b/googleapiclient/discovery_cache/documents/servicedirectory.v1.json @@ -883,7 +883,7 @@ } } }, - "revision": "20220630", + "revision": "20220706", "rootUrl": "https://servicedirectory.googleapis.com/", "schemas": { "Binding": { diff --git a/googleapiclient/discovery_cache/documents/servicedirectory.v1beta1.json b/googleapiclient/discovery_cache/documents/servicedirectory.v1beta1.json index c7983e8a488..ee497bc08b1 100644 --- a/googleapiclient/discovery_cache/documents/servicedirectory.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/servicedirectory.v1beta1.json @@ -971,7 +971,7 @@ } } }, - "revision": "20220630", + "revision": "20220706", "rootUrl": "https://servicedirectory.googleapis.com/", "schemas": { "Binding": { diff --git a/googleapiclient/discovery_cache/documents/servicemanagement.v1.json b/googleapiclient/discovery_cache/documents/servicemanagement.v1.json index 1e3758ba7e8..08fff24b614 100644 --- a/googleapiclient/discovery_cache/documents/servicemanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/servicemanagement.v1.json @@ -829,7 +829,7 @@ } } }, - "revision": "20220624", + "revision": "20220712", "rootUrl": "https://servicemanagement.googleapis.com/", "schemas": { "Advice": { diff --git a/googleapiclient/discovery_cache/documents/serviceusage.v1.json b/googleapiclient/discovery_cache/documents/serviceusage.v1.json index 8c6af62a663..248e5e70dfd 100644 --- a/googleapiclient/discovery_cache/documents/serviceusage.v1.json +++ b/googleapiclient/discovery_cache/documents/serviceusage.v1.json @@ -426,7 +426,7 @@ } } }, - "revision": "20220706", + "revision": "20220715", "rootUrl": "https://serviceusage.googleapis.com/", "schemas": { "AdminQuotaPolicy": { diff --git a/googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json b/googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json index e9706bb41fa..729519751f6 100644 --- a/googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json @@ -959,7 +959,7 @@ } } }, - "revision": "20220706", + "revision": "20220715", "rootUrl": "https://serviceusage.googleapis.com/", "schemas": { "AdminQuotaPolicy": { diff --git a/googleapiclient/discovery_cache/documents/smartdevicemanagement.v1.json b/googleapiclient/discovery_cache/documents/smartdevicemanagement.v1.json index d711faceeb4..6bd7bdc8e75 100644 --- a/googleapiclient/discovery_cache/documents/smartdevicemanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/smartdevicemanagement.v1.json @@ -355,7 +355,7 @@ } } }, - "revision": "20220703", + "revision": "20220708", "rootUrl": "https://smartdevicemanagement.googleapis.com/", "schemas": { "GoogleHomeEnterpriseSdmV1Device": { diff --git a/googleapiclient/discovery_cache/documents/sourcerepo.v1.json b/googleapiclient/discovery_cache/documents/sourcerepo.v1.json index 57f61501abc..f9e5e958719 100644 --- a/googleapiclient/discovery_cache/documents/sourcerepo.v1.json +++ b/googleapiclient/discovery_cache/documents/sourcerepo.v1.json @@ -450,7 +450,7 @@ } } }, - "revision": "20220630", + "revision": "20220711", "rootUrl": "https://sourcerepo.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/googleapiclient/discovery_cache/documents/speech.v1.json b/googleapiclient/discovery_cache/documents/speech.v1.json index 32f619da53e..a58c8e1dae7 100644 --- a/googleapiclient/discovery_cache/documents/speech.v1.json +++ b/googleapiclient/discovery_cache/documents/speech.v1.json @@ -524,7 +524,7 @@ } } }, - "revision": "20220624", + "revision": "20220712", "rootUrl": "https://speech.googleapis.com/", "schemas": { "ClassItem": { diff --git a/googleapiclient/discovery_cache/documents/speech.v1p1beta1.json b/googleapiclient/discovery_cache/documents/speech.v1p1beta1.json index ae5e43bb76c..922332bffe6 100644 --- a/googleapiclient/discovery_cache/documents/speech.v1p1beta1.json +++ b/googleapiclient/discovery_cache/documents/speech.v1p1beta1.json @@ -524,7 +524,7 @@ } } }, - "revision": "20220624", + "revision": "20220712", "rootUrl": "https://speech.googleapis.com/", "schemas": { "ClassItem": { diff --git a/googleapiclient/discovery_cache/documents/speech.v2beta1.json b/googleapiclient/discovery_cache/documents/speech.v2beta1.json index edd916f0b46..66bb8c1c395 100644 --- a/googleapiclient/discovery_cache/documents/speech.v2beta1.json +++ b/googleapiclient/discovery_cache/documents/speech.v2beta1.json @@ -184,7 +184,7 @@ } } }, - "revision": "20220624", + "revision": "20220712", "rootUrl": "https://speech.googleapis.com/", "schemas": { "ListOperationsResponse": { diff --git a/googleapiclient/discovery_cache/documents/storage.v1.json b/googleapiclient/discovery_cache/documents/storage.v1.json index 83d4a6ced1a..18f7d5a4393 100644 --- a/googleapiclient/discovery_cache/documents/storage.v1.json +++ b/googleapiclient/discovery_cache/documents/storage.v1.json @@ -26,7 +26,7 @@ "description": "Stores and retrieves potentially large, immutable data objects.", "discoveryVersion": "v1", "documentationLink": "https://developers.google.com/storage/docs/json_api/", - "etag": "\"34353536323138353533303038393231383237\"", + "etag": "\"3135383237353934393938313532383135323239\"", "icons": { "x16": "https://www.google.com/images/icons/product/cloud_storage-16.png", "x32": "https://www.google.com/images/icons/product/cloud_storage-32.png" @@ -3005,7 +3005,7 @@ } } }, - "revision": "20220709", + "revision": "20220713", "rootUrl": "https://storage.googleapis.com/", "schemas": { "Bucket": { diff --git a/googleapiclient/discovery_cache/documents/streetviewpublish.v1.json b/googleapiclient/discovery_cache/documents/streetviewpublish.v1.json index 00c740212bd..e1fb8e410fe 100644 --- a/googleapiclient/discovery_cache/documents/streetviewpublish.v1.json +++ b/googleapiclient/discovery_cache/documents/streetviewpublish.v1.json @@ -533,7 +533,7 @@ } } }, - "revision": "20220708", + "revision": "20220716", "rootUrl": "https://streetviewpublish.googleapis.com/", "schemas": { "BatchDeletePhotosRequest": { diff --git a/googleapiclient/discovery_cache/documents/sts.v1.json b/googleapiclient/discovery_cache/documents/sts.v1.json index a5eea9f14e6..7382fad9488 100644 --- a/googleapiclient/discovery_cache/documents/sts.v1.json +++ b/googleapiclient/discovery_cache/documents/sts.v1.json @@ -131,7 +131,7 @@ } } }, - "revision": "20220625", + "revision": "20220708", "rootUrl": "https://sts.googleapis.com/", "schemas": { "GoogleIamV1Binding": { diff --git a/googleapiclient/discovery_cache/documents/sts.v1beta.json b/googleapiclient/discovery_cache/documents/sts.v1beta.json index 8c88b80e0a9..a763046c3ee 100644 --- a/googleapiclient/discovery_cache/documents/sts.v1beta.json +++ b/googleapiclient/discovery_cache/documents/sts.v1beta.json @@ -116,7 +116,7 @@ } } }, - "revision": "20220625", + "revision": "20220708", "rootUrl": "https://sts.googleapis.com/", "schemas": { "GoogleIamV1Binding": { diff --git a/googleapiclient/discovery_cache/documents/tagmanager.v1.json b/googleapiclient/discovery_cache/documents/tagmanager.v1.json index 5bb2b0e12bc..2ae3057b163 100644 --- a/googleapiclient/discovery_cache/documents/tagmanager.v1.json +++ b/googleapiclient/discovery_cache/documents/tagmanager.v1.json @@ -1932,7 +1932,7 @@ } } }, - "revision": "20220704", + "revision": "20220718", "rootUrl": "https://tagmanager.googleapis.com/", "schemas": { "Account": { diff --git a/googleapiclient/discovery_cache/documents/tagmanager.v2.json b/googleapiclient/discovery_cache/documents/tagmanager.v2.json index 8dd0683c456..3bd086e0bf9 100644 --- a/googleapiclient/discovery_cache/documents/tagmanager.v2.json +++ b/googleapiclient/discovery_cache/documents/tagmanager.v2.json @@ -3317,7 +3317,7 @@ } } }, - "revision": "20220704", + "revision": "20220718", "rootUrl": "https://tagmanager.googleapis.com/", "schemas": { "Account": { diff --git a/googleapiclient/discovery_cache/documents/tasks.v1.json b/googleapiclient/discovery_cache/documents/tasks.v1.json index e0a17985279..4b117be939c 100644 --- a/googleapiclient/discovery_cache/documents/tasks.v1.json +++ b/googleapiclient/discovery_cache/documents/tasks.v1.json @@ -566,7 +566,7 @@ } } }, - "revision": "20220708", + "revision": "20220715", "rootUrl": "https://tasks.googleapis.com/", "schemas": { "Task": { diff --git a/googleapiclient/discovery_cache/documents/testing.v1.json b/googleapiclient/discovery_cache/documents/testing.v1.json index 60f5985d020..c9eaefec189 100644 --- a/googleapiclient/discovery_cache/documents/testing.v1.json +++ b/googleapiclient/discovery_cache/documents/testing.v1.json @@ -282,7 +282,7 @@ } } }, - "revision": "20220623", + "revision": "20220705", "rootUrl": "https://testing.googleapis.com/", "schemas": { "Account": { diff --git a/googleapiclient/discovery_cache/documents/texttospeech.v1.json b/googleapiclient/discovery_cache/documents/texttospeech.v1.json index 41bb8ea8522..a1e19fd2b07 100644 --- a/googleapiclient/discovery_cache/documents/texttospeech.v1.json +++ b/googleapiclient/discovery_cache/documents/texttospeech.v1.json @@ -153,7 +153,7 @@ } } }, - "revision": "20220707", + "revision": "20220708", "rootUrl": "https://texttospeech.googleapis.com/", "schemas": { "AudioConfig": { diff --git a/googleapiclient/discovery_cache/documents/texttospeech.v1beta1.json b/googleapiclient/discovery_cache/documents/texttospeech.v1beta1.json index c7c36150a9f..228d56124e9 100644 --- a/googleapiclient/discovery_cache/documents/texttospeech.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/texttospeech.v1beta1.json @@ -153,7 +153,7 @@ } } }, - "revision": "20220707", + "revision": "20220708", "rootUrl": "https://texttospeech.googleapis.com/", "schemas": { "AudioConfig": { diff --git a/googleapiclient/discovery_cache/documents/toolresults.v1beta3.json b/googleapiclient/discovery_cache/documents/toolresults.v1beta3.json index 4d9f5e9ba6b..f87147e8da8 100644 --- a/googleapiclient/discovery_cache/documents/toolresults.v1beta3.json +++ b/googleapiclient/discovery_cache/documents/toolresults.v1beta3.json @@ -1463,7 +1463,7 @@ } } }, - "revision": "20220711", + "revision": "20220716", "rootUrl": "https://toolresults.googleapis.com/", "schemas": { "ANR": { diff --git a/googleapiclient/discovery_cache/documents/tpu.v1.json b/googleapiclient/discovery_cache/documents/tpu.v1.json index 228d0b1ea1e..16b700e9ef6 100644 --- a/googleapiclient/discovery_cache/documents/tpu.v1.json +++ b/googleapiclient/discovery_cache/documents/tpu.v1.json @@ -659,7 +659,7 @@ } } }, - "revision": "20220629", + "revision": "20220714", "rootUrl": "https://tpu.googleapis.com/", "schemas": { "AcceleratorType": { @@ -861,7 +861,7 @@ "V2_ALPHA1" ], "enumDescriptions": [ - "API version is unknown.", + "LINT.IfChange API version is unknown.", "TPU API V1Alpha1 version.", "TPU API V1 version.", "TPU API V2Alpha1 version." @@ -969,7 +969,7 @@ "UNHIDING" ], "enumDescriptions": [ - "TPU node state is not known/set.", + "LINT.IfChange TPU node state is not known/set.", "TPU node is being created.", "TPU node has been created.", "TPU node is restarting.", @@ -983,7 +983,7 @@ "TPU node has been terminated due to maintenance or has reached the end of its life cycle (for preemptible nodes).", "TPU node is currently hiding.", "TPU node has been hidden.", - "TPU node is currently unhiding." + "TPU node is currently unhiding. LINT.ThenChange(//depot/google3/java/com/google/cloud/boq/clientapi/tpu/api/gce_tpu.proto)" ], "readOnly": true, "type": "string" diff --git a/googleapiclient/discovery_cache/documents/tpu.v1alpha1.json b/googleapiclient/discovery_cache/documents/tpu.v1alpha1.json index d74ac64b2c8..2439f9b90cf 100644 --- a/googleapiclient/discovery_cache/documents/tpu.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/tpu.v1alpha1.json @@ -669,7 +669,7 @@ } } }, - "revision": "20220629", + "revision": "20220714", "rootUrl": "https://tpu.googleapis.com/", "schemas": { "AcceleratorType": { @@ -871,7 +871,7 @@ "V2_ALPHA1" ], "enumDescriptions": [ - "API version is unknown.", + "LINT.IfChange API version is unknown.", "TPU API V1Alpha1 version.", "TPU API V1 version.", "TPU API V2Alpha1 version." @@ -979,7 +979,7 @@ "UNHIDING" ], "enumDescriptions": [ - "TPU node state is not known/set.", + "LINT.IfChange TPU node state is not known/set.", "TPU node is being created.", "TPU node has been created.", "TPU node is restarting.", @@ -993,7 +993,7 @@ "TPU node has been terminated due to maintenance or has reached the end of its life cycle (for preemptible nodes).", "TPU node is currently hiding.", "TPU node has been hidden.", - "TPU node is currently unhiding." + "TPU node is currently unhiding. LINT.ThenChange(//depot/google3/java/com/google/cloud/boq/clientapi/tpu/api/gce_tpu.proto)" ], "readOnly": true, "type": "string" diff --git a/googleapiclient/discovery_cache/documents/tpu.v2alpha1.json b/googleapiclient/discovery_cache/documents/tpu.v2alpha1.json index b126aa0a155..b42f5f98eb5 100644 --- a/googleapiclient/discovery_cache/documents/tpu.v2alpha1.json +++ b/googleapiclient/discovery_cache/documents/tpu.v2alpha1.json @@ -759,7 +759,7 @@ } } }, - "revision": "20220629", + "revision": "20220714", "rootUrl": "https://tpu.googleapis.com/", "schemas": { "AcceleratorType": { @@ -1122,7 +1122,7 @@ "V2_ALPHA1" ], "enumDescriptions": [ - "API version is unknown.", + "LINT.IfChange API version is unknown.", "TPU API V1Alpha1 version.", "TPU API V1 version.", "TPU API V2Alpha1 version." @@ -1243,7 +1243,7 @@ "UNHIDING" ], "enumDescriptions": [ - "TPU node state is not known/set.", + "LINT.IfChange TPU node state is not known/set.", "TPU node is being created.", "TPU node has been created.", "TPU node is restarting.", @@ -1257,7 +1257,7 @@ "TPU node has been terminated due to maintenance or has reached the end of its life cycle (for preemptible nodes).", "TPU node is currently hiding.", "TPU node has been hidden.", - "TPU node is currently unhiding." + "TPU node is currently unhiding. LINT.ThenChange(//depot/google3/java/com/google/cloud/boq/clientapi/tpu/api/gce_tpu.proto)" ], "readOnly": true, "type": "string" diff --git a/googleapiclient/discovery_cache/documents/trafficdirector.v2.json b/googleapiclient/discovery_cache/documents/trafficdirector.v2.json index ea93da27656..2ed934a857b 100644 --- a/googleapiclient/discovery_cache/documents/trafficdirector.v2.json +++ b/googleapiclient/discovery_cache/documents/trafficdirector.v2.json @@ -128,7 +128,7 @@ } } }, - "revision": "20220608", + "revision": "20220624", "rootUrl": "https://trafficdirector.googleapis.com/", "schemas": { "Address": { diff --git a/googleapiclient/discovery_cache/documents/transcoder.v1.json b/googleapiclient/discovery_cache/documents/transcoder.v1.json index ba9d028b2cd..fbff2e5afb7 100644 --- a/googleapiclient/discovery_cache/documents/transcoder.v1.json +++ b/googleapiclient/discovery_cache/documents/transcoder.v1.json @@ -385,7 +385,7 @@ } } }, - "revision": "20220623", + "revision": "20220707", "rootUrl": "https://transcoder.googleapis.com/", "schemas": { "AdBreak": { diff --git a/googleapiclient/discovery_cache/documents/translate.v3.json b/googleapiclient/discovery_cache/documents/translate.v3.json index 1c5c2cbbb20..6fbaf52797e 100644 --- a/googleapiclient/discovery_cache/documents/translate.v3.json +++ b/googleapiclient/discovery_cache/documents/translate.v3.json @@ -744,7 +744,7 @@ } } }, - "revision": "20220602", + "revision": "20220711", "rootUrl": "https://translation.googleapis.com/", "schemas": { "BatchDocumentInputConfig": { diff --git a/googleapiclient/discovery_cache/documents/translate.v3beta1.json b/googleapiclient/discovery_cache/documents/translate.v3beta1.json index 87e0a279c7b..afa760baf34 100644 --- a/googleapiclient/discovery_cache/documents/translate.v3beta1.json +++ b/googleapiclient/discovery_cache/documents/translate.v3beta1.json @@ -744,7 +744,7 @@ } } }, - "revision": "20220602", + "revision": "20220711", "rootUrl": "https://translation.googleapis.com/", "schemas": { "BatchDocumentInputConfig": { diff --git a/googleapiclient/discovery_cache/documents/vault.v1.json b/googleapiclient/discovery_cache/documents/vault.v1.json index c336afb74a3..621ac4aa73b 100644 --- a/googleapiclient/discovery_cache/documents/vault.v1.json +++ b/googleapiclient/discovery_cache/documents/vault.v1.json @@ -1193,7 +1193,7 @@ } } }, - "revision": "20220630", + "revision": "20220713", "rootUrl": "https://vault.googleapis.com/", "schemas": { "AccountCount": { diff --git a/googleapiclient/discovery_cache/documents/versionhistory.v1.json b/googleapiclient/discovery_cache/documents/versionhistory.v1.json index 84c15b9b1e1..32b50a89d46 100644 --- a/googleapiclient/discovery_cache/documents/versionhistory.v1.json +++ b/googleapiclient/discovery_cache/documents/versionhistory.v1.json @@ -271,7 +271,7 @@ } } }, - "revision": "20220711", + "revision": "20220718", "rootUrl": "https://versionhistory.googleapis.com/", "schemas": { "Channel": { diff --git a/googleapiclient/discovery_cache/documents/vision.v1.json b/googleapiclient/discovery_cache/documents/vision.v1.json index ad7b2a030a8..a95d3d117ff 100644 --- a/googleapiclient/discovery_cache/documents/vision.v1.json +++ b/googleapiclient/discovery_cache/documents/vision.v1.json @@ -1282,7 +1282,7 @@ } } }, - "revision": "20220701", + "revision": "20220713", "rootUrl": "https://vision.googleapis.com/", "schemas": { "AddProductToProductSetRequest": { diff --git a/googleapiclient/discovery_cache/documents/vision.v1p1beta1.json b/googleapiclient/discovery_cache/documents/vision.v1p1beta1.json index c6f4b6becf0..c45c3c43e35 100644 --- a/googleapiclient/discovery_cache/documents/vision.v1p1beta1.json +++ b/googleapiclient/discovery_cache/documents/vision.v1p1beta1.json @@ -449,7 +449,7 @@ } } }, - "revision": "20220701", + "revision": "20220713", "rootUrl": "https://vision.googleapis.com/", "schemas": { "AnnotateFileResponse": { diff --git a/googleapiclient/discovery_cache/documents/vision.v1p2beta1.json b/googleapiclient/discovery_cache/documents/vision.v1p2beta1.json index c9292be84d0..517d97837b8 100644 --- a/googleapiclient/discovery_cache/documents/vision.v1p2beta1.json +++ b/googleapiclient/discovery_cache/documents/vision.v1p2beta1.json @@ -449,7 +449,7 @@ } } }, - "revision": "20220701", + "revision": "20220713", "rootUrl": "https://vision.googleapis.com/", "schemas": { "AnnotateFileResponse": { diff --git a/googleapiclient/discovery_cache/documents/vmmigration.v1.json b/googleapiclient/discovery_cache/documents/vmmigration.v1.json index e5e6a4518c5..c9d4794f2ab 100644 --- a/googleapiclient/discovery_cache/documents/vmmigration.v1.json +++ b/googleapiclient/discovery_cache/documents/vmmigration.v1.json @@ -1972,7 +1972,7 @@ } } }, - "revision": "20220630", + "revision": "20220707", "rootUrl": "https://vmmigration.googleapis.com/", "schemas": { "AddGroupMigrationRequest": { diff --git a/googleapiclient/discovery_cache/documents/vmmigration.v1alpha1.json b/googleapiclient/discovery_cache/documents/vmmigration.v1alpha1.json index d3f8daada25..c76bde53835 100644 --- a/googleapiclient/discovery_cache/documents/vmmigration.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/vmmigration.v1alpha1.json @@ -1972,7 +1972,7 @@ } } }, - "revision": "20220630", + "revision": "20220707", "rootUrl": "https://vmmigration.googleapis.com/", "schemas": { "AdaptingOSStep": { diff --git a/googleapiclient/discovery_cache/documents/webrisk.v1.json b/googleapiclient/discovery_cache/documents/webrisk.v1.json index 57b46558648..bddb1b507ed 100644 --- a/googleapiclient/discovery_cache/documents/webrisk.v1.json +++ b/googleapiclient/discovery_cache/documents/webrisk.v1.json @@ -127,14 +127,14 @@ "MALWARE", "SOCIAL_ENGINEERING", "UNWANTED_SOFTWARE", - "HIGH_RECALL" + "SOCIAL_ENGINEERING_EXTENDED_COVERAGE" ], "enumDescriptions": [ "No entries should match this threat type. This threat type is unused.", "Malware targeting any platform.", "Social engineering targeting any platform.", "Unwanted software targeting any platform.", - "High Recall Social Engineering list targeting any platform." + "Extended Coverage Social Engineering list targeting any platform." ], "location": "query", "repeated": true, @@ -377,14 +377,14 @@ "MALWARE", "SOCIAL_ENGINEERING", "UNWANTED_SOFTWARE", - "HIGH_RECALL" + "SOCIAL_ENGINEERING_EXTENDED_COVERAGE" ], "enumDescriptions": [ "No entries should match this threat type. This threat type is unused.", "Malware targeting any platform.", "Social engineering targeting any platform.", "Unwanted software targeting any platform.", - "High Recall Social Engineering list targeting any platform." + "Extended Coverage Social Engineering list targeting any platform." ], "location": "query", "type": "string" @@ -422,14 +422,14 @@ "MALWARE", "SOCIAL_ENGINEERING", "UNWANTED_SOFTWARE", - "HIGH_RECALL" + "SOCIAL_ENGINEERING_EXTENDED_COVERAGE" ], "enumDescriptions": [ "No entries should match this threat type. This threat type is unused.", "Malware targeting any platform.", "Social engineering targeting any platform.", "Unwanted software targeting any platform.", - "High Recall Social Engineering list targeting any platform." + "Extended Coverage Social Engineering list targeting any platform." ], "location": "query", "repeated": true, @@ -452,7 +452,7 @@ } } }, - "revision": "20220625", + "revision": "20220708", "rootUrl": "https://webrisk.googleapis.com/", "schemas": { "GoogleCloudWebriskV1ComputeThreatListDiffResponse": { @@ -608,14 +608,14 @@ "MALWARE", "SOCIAL_ENGINEERING", "UNWANTED_SOFTWARE", - "HIGH_RECALL" + "SOCIAL_ENGINEERING_EXTENDED_COVERAGE" ], "enumDescriptions": [ "No entries should match this threat type. This threat type is unused.", "Malware targeting any platform.", "Social engineering targeting any platform.", "Unwanted software targeting any platform.", - "High Recall Social Engineering list targeting any platform." + "Extended Coverage Social Engineering list targeting any platform." ], "type": "string" }, @@ -651,14 +651,14 @@ "MALWARE", "SOCIAL_ENGINEERING", "UNWANTED_SOFTWARE", - "HIGH_RECALL" + "SOCIAL_ENGINEERING_EXTENDED_COVERAGE" ], "enumDescriptions": [ "No entries should match this threat type. This threat type is unused.", "Malware targeting any platform.", "Social engineering targeting any platform.", "Unwanted software targeting any platform.", - "High Recall Social Engineering list targeting any platform." + "Extended Coverage Social Engineering list targeting any platform." ], "type": "string" }, @@ -679,14 +679,14 @@ "MALWARE", "SOCIAL_ENGINEERING", "UNWANTED_SOFTWARE", - "HIGH_RECALL" + "SOCIAL_ENGINEERING_EXTENDED_COVERAGE" ], "enumDescriptions": [ "No entries should match this threat type. This threat type is unused.", "Malware targeting any platform.", "Social engineering targeting any platform.", "Unwanted software targeting any platform.", - "High Recall Social Engineering list targeting any platform." + "Extended Coverage Social Engineering list targeting any platform." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/websecurityscanner.v1.json b/googleapiclient/discovery_cache/documents/websecurityscanner.v1.json index 5e83be22dcb..6ebd5f58eb8 100644 --- a/googleapiclient/discovery_cache/documents/websecurityscanner.v1.json +++ b/googleapiclient/discovery_cache/documents/websecurityscanner.v1.json @@ -526,7 +526,7 @@ } } }, - "revision": "20220630", + "revision": "20220708", "rootUrl": "https://websecurityscanner.googleapis.com/", "schemas": { "Authentication": { diff --git a/googleapiclient/discovery_cache/documents/websecurityscanner.v1alpha.json b/googleapiclient/discovery_cache/documents/websecurityscanner.v1alpha.json index c9465b9ba72..670c590dd71 100644 --- a/googleapiclient/discovery_cache/documents/websecurityscanner.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/websecurityscanner.v1alpha.json @@ -526,7 +526,7 @@ } } }, - "revision": "20220630", + "revision": "20220708", "rootUrl": "https://websecurityscanner.googleapis.com/", "schemas": { "Authentication": { diff --git a/googleapiclient/discovery_cache/documents/websecurityscanner.v1beta.json b/googleapiclient/discovery_cache/documents/websecurityscanner.v1beta.json index 097bbd92ce2..f0f1f5a4085 100644 --- a/googleapiclient/discovery_cache/documents/websecurityscanner.v1beta.json +++ b/googleapiclient/discovery_cache/documents/websecurityscanner.v1beta.json @@ -526,7 +526,7 @@ } } }, - "revision": "20220630", + "revision": "20220708", "rootUrl": "https://websecurityscanner.googleapis.com/", "schemas": { "Authentication": { diff --git a/googleapiclient/discovery_cache/documents/workflowexecutions.v1.json b/googleapiclient/discovery_cache/documents/workflowexecutions.v1.json index 715a68c1d12..3efc20a7afa 100644 --- a/googleapiclient/discovery_cache/documents/workflowexecutions.v1.json +++ b/googleapiclient/discovery_cache/documents/workflowexecutions.v1.json @@ -299,7 +299,7 @@ } } }, - "revision": "20220704", + "revision": "20220708", "rootUrl": "https://workflowexecutions.googleapis.com/", "schemas": { "CancelExecutionRequest": { diff --git a/googleapiclient/discovery_cache/documents/workflowexecutions.v1beta.json b/googleapiclient/discovery_cache/documents/workflowexecutions.v1beta.json index 301b94f1351..bdbeca648d2 100644 --- a/googleapiclient/discovery_cache/documents/workflowexecutions.v1beta.json +++ b/googleapiclient/discovery_cache/documents/workflowexecutions.v1beta.json @@ -269,7 +269,7 @@ } } }, - "revision": "20220704", + "revision": "20220708", "rootUrl": "https://workflowexecutions.googleapis.com/", "schemas": { "CancelExecutionRequest": { diff --git a/googleapiclient/discovery_cache/documents/workflows.v1.json b/googleapiclient/discovery_cache/documents/workflows.v1.json index 7fa95ef5e27..b3b1f19cd6c 100644 --- a/googleapiclient/discovery_cache/documents/workflows.v1.json +++ b/googleapiclient/discovery_cache/documents/workflows.v1.json @@ -444,7 +444,7 @@ } } }, - "revision": "20220623", + "revision": "20220707", "rootUrl": "https://workflows.googleapis.com/", "schemas": { "Empty": { diff --git a/googleapiclient/discovery_cache/documents/workflows.v1beta.json b/googleapiclient/discovery_cache/documents/workflows.v1beta.json index 1cf415b53b5..d12cfd11356 100644 --- a/googleapiclient/discovery_cache/documents/workflows.v1beta.json +++ b/googleapiclient/discovery_cache/documents/workflows.v1beta.json @@ -444,7 +444,7 @@ } } }, - "revision": "20220623", + "revision": "20220707", "rootUrl": "https://workflows.googleapis.com/", "schemas": { "Empty": { diff --git a/googleapiclient/discovery_cache/documents/youtubeAnalytics.v2.json b/googleapiclient/discovery_cache/documents/youtubeAnalytics.v2.json index 25a6bd60750..b7dd4c82607 100644 --- a/googleapiclient/discovery_cache/documents/youtubeAnalytics.v2.json +++ b/googleapiclient/discovery_cache/documents/youtubeAnalytics.v2.json @@ -421,7 +421,7 @@ } } }, - "revision": "20220708", + "revision": "20220716", "rootUrl": "https://youtubeanalytics.googleapis.com/", "schemas": { "EmptyResponse": { diff --git a/googleapiclient/discovery_cache/documents/youtubereporting.v1.json b/googleapiclient/discovery_cache/documents/youtubereporting.v1.json index 0a319ba746c..da2a3b87695 100644 --- a/googleapiclient/discovery_cache/documents/youtubereporting.v1.json +++ b/googleapiclient/discovery_cache/documents/youtubereporting.v1.json @@ -411,7 +411,7 @@ } } }, - "revision": "20220708", + "revision": "20220716", "rootUrl": "https://youtubereporting.googleapis.com/", "schemas": { "Empty": {